Skip to content

Commit ab629c1

Browse files
authored
Merge pull request #1352 from horriblename/doc-ndg-toml
docs: move ndg options into ndg.toml
2 parents 18c55d3 + 40c1ffa commit ab629c1

File tree

2 files changed

+29
-4
lines changed

2 files changed

+29
-4
lines changed

docs/manual.nix

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,10 @@ in
3131
3232
# Generate the final manual from a set of parameters. This uses
3333
# feel-co/ndg to render the web manual.
34-
ndg html \
34+
ndg --config-file ${./ndg.toml} html \
3535
--jobs $NIX_BUILD_CORES --title "NVF" \
3636
--module-options ${optionsJSON}/share/doc/nixos/options.json \
3737
--manpage-urls ${path}/doc/manpage-urls.json \
38-
--options-depth 3 \
39-
--generate-search \
40-
--highlight-code \
4138
--input-dir ./manual \
4239
--output-dir "$out/share/doc"
4340

docs/ndg.toml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# NDG Configuration File
2+
3+
# Input directory containing markdown files
4+
input_dir = "docs"
5+
6+
# Output directory for generated documentation
7+
output_dir = "build"
8+
9+
# Title for the documentation
10+
title = "NVF"
11+
12+
# Footer text for the documentation
13+
footer_text = "Generated with ndg"
14+
15+
generate_anchors = true
16+
17+
# Search configuration
18+
[search]
19+
enable = true
20+
highlight_code = true
21+
tab_style = "none"
22+
revision = "main"
23+
24+
# Maximum heading level to index
25+
max_heading_level = 3
26+
27+
# Depth of parent categories in options TOC
28+
options_toc_depth = 2

0 commit comments

Comments
 (0)