mirror of
https://github.com/NotAShelf/nvf.git
synced 2026-02-03 18:35:52 +00:00
Merge pull request #1352 from horriblename/doc-ndg-toml
docs: move ndg options into ndg.toml
This commit is contained in:
commit
ab629c1995
2 changed files with 29 additions and 4 deletions
|
|
@ -31,13 +31,10 @@ in
|
||||||
|
|
||||||
# Generate the final manual from a set of parameters. This uses
|
# Generate the final manual from a set of parameters. This uses
|
||||||
# feel-co/ndg to render the web manual.
|
# feel-co/ndg to render the web manual.
|
||||||
ndg html \
|
ndg --config-file ${./ndg.toml} html \
|
||||||
--jobs $NIX_BUILD_CORES --title "NVF" \
|
--jobs $NIX_BUILD_CORES --title "NVF" \
|
||||||
--module-options ${optionsJSON}/share/doc/nixos/options.json \
|
--module-options ${optionsJSON}/share/doc/nixos/options.json \
|
||||||
--manpage-urls ${path}/doc/manpage-urls.json \
|
--manpage-urls ${path}/doc/manpage-urls.json \
|
||||||
--options-depth 3 \
|
|
||||||
--generate-search \
|
|
||||||
--highlight-code \
|
|
||||||
--input-dir ./manual \
|
--input-dir ./manual \
|
||||||
--output-dir "$out/share/doc"
|
--output-dir "$out/share/doc"
|
||||||
|
|
||||||
|
|
|
||||||
28
docs/ndg.toml
Normal file
28
docs/ndg.toml
Normal 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
|
||||||
Loading…
Add table
Add a link
Reference in a new issue