docs: move ndg options into ndg.toml

This commit is contained in:
Ching Pei Yang 2026-01-22 20:35:03 +01:00
commit 40c1ffab4a
No known key found for this signature in database
GPG key ID: B3841364253DC4C8
2 changed files with 29 additions and 4 deletions

View file

@ -31,13 +31,10 @@ in
# Generate the final manual from a set of parameters. This uses
# feel-co/ndg to render the web manual.
ndg html \
ndg --config-file ${./ndg.toml} html \
--jobs $NIX_BUILD_CORES --title "NVF" \
--module-options ${optionsJSON}/share/doc/nixos/options.json \
--manpage-urls ${path}/doc/manpage-urls.json \
--options-depth 3 \
--generate-search \
--highlight-code \
--input-dir ./manual \
--output-dir "$out/share/doc"

28
docs/ndg.toml Normal file
View file

@ -0,0 +1,28 @@
# NDG Configuration File
# Input directory containing markdown files
input_dir = "docs"
# Output directory for generated documentation
output_dir = "build"
# Title for the documentation
title = "NVF"
# Footer text for the documentation
footer_text = "Generated with ndg"
generate_anchors = true
# Search configuration
[search]
enable = true
highlight_code = true
tab_style = "none"
revision = "main"
# Maximum heading level to index
max_heading_level = 3
# Depth of parent categories in options TOC
options_toc_depth = 2