Config Options
Command Line Flags
The following flags control ndgBook's behavior:
| Flag | Default | Description |
|---|---|---|
| --outDir:DIR | docs | Output directory |
| --index:on\|off | off | Generate .idx files |
| --fullTextIndexation:on\|off | off | Index paragraphs for search |
| --summary:PATH | none | Path to SUMMARY.md |
| --git.url:URL | none | Base URL for source links |
| --git.commit:REF | none | Branch/commit for source links |
| --project | off | Process all linked files |
Example with all options:
nim doc --project --outDir:public --index:on --fullTextIndexation:on --summary:src/SUMMARY.md --git.url:https://github.com/user/repo --git.commit:main src/index.md