Config Options

Source   Edit  

Config Options

Command Line Flags

The following flags control ndgBook's behavior:

FlagDefaultDescription
--outDir:DIRdocsOutput directory
--index:on\|offoffGenerate .idx files
--fullTextIndexation:on\|offoffIndex paragraphs for search
--summary:PATHnonePath to SUMMARY.md
--git.url:URLnoneBase URL for source links
--git.commit:REFnoneBranch/commit for source links
--projectoffProcess 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