diff --git a/.editorconfig b/.editorconfig index 1f39b72e..f316f5ab 100644 --- a/.editorconfig +++ b/.editorconfig @@ -13,6 +13,7 @@ trim_trailing_whitespace = true indent_style = space indent_size = 2 trim_trailing_whitespace = false +max_line_length = 80 [*.{js,json,nix,yml,yaml,toml}] indent_style = space diff --git a/docs/manual.nix b/docs/manual.nix index 132c20ef..4bbd75a0 100644 --- a/docs/manual.nix +++ b/docs/manual.nix @@ -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" diff --git a/docs/ndg.toml b/docs/ndg.toml new file mode 100644 index 00000000..7105c709 --- /dev/null +++ b/docs/ndg.toml @@ -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