Commands

You can see a list of commands by running lingdocs --help; you can see information for an individual command by running lingdocs <COMMAND> --help.

build

Create formatted output of lingdocs project.

Usage:

build [OPTIONS]

Options:

  --targets TEXT     List of target output formats.
  --release          Prepare for a citeable release
  --output-dir PATH  Folder where output is generated.  [default: output]
  --source PATH      Source folder to process.  [default: .]
  --cldf TEXT        Path to metadata.json of CLDF dataset.
  --help             Show this message and exit.

preview

Create a live preview using a lightweight, human-readable output format

Usage:

preview [OPTIONS]

Options:

  --target TEXT      Output format for the preview.
  --refresh BOOLEAN  Re-render preview on file change.  [default: True]
  --output-dir PATH  Folder where output is generated.  [default: output]
  --source PATH      Source folder to process.  [default: .]
  --cldf TEXT        Path to metadata.json of CLDF dataset.
  --help             Show this message and exit.

new

Create a new lingdocs project.

Usage:

new [OPTIONS]

Options:

  --help  Show this message and exit.