Compare commits

...

4 commits

Author SHA1 Message Date
raf
bebdddb571
Merge pull request #1351 from NotAShelf/editorconfig-md
Some checks are pending
Set up binary cache / cachix (default) (push) Waiting to run
Set up binary cache / cachix (maximal) (push) Waiting to run
Set up binary cache / cachix (nix) (push) Waiting to run
Treewide Checks / Validate flake (push) Waiting to run
Treewide Checks / Check formatting (push) Waiting to run
Treewide Checks / Check source tree for typos (push) Waiting to run
Treewide Checks / Validate documentation builds (push) Waiting to run
Treewide Checks / Validate documentation builds-1 (push) Waiting to run
Treewide Checks / Validate documentation builds-2 (push) Waiting to run
Treewide Checks / Validate documentation builds-3 (push) Waiting to run
Treewide Checks / Validate hyperlinks in documentation sources (push) Waiting to run
Treewide Checks / Validate Editorconfig conformance (push) Waiting to run
Build and deploy documentation / Check latest commit (push) Waiting to run
Build and deploy documentation / publish (push) Blocked by required conditions
add textwidth setting in editorconfig
2026-01-22 22:48:33 +03:00
raf
ab629c1995
Merge pull request #1352 from horriblename/doc-ndg-toml
docs: move ndg options into ndg.toml
2026-01-22 22:48:24 +03:00
Ching Pei Yang
40c1ffab4a
docs: move ndg options into ndg.toml 2026-01-22 20:40:26 +01:00
Ching Pei Yang
937b5a2fe9
editorcnofig: add textwidth setting for md 2026-01-22 20:13:00 +01:00
3 changed files with 30 additions and 4 deletions

View file

@ -13,6 +13,7 @@ trim_trailing_whitespace = true
indent_style = space indent_style = space
indent_size = 2 indent_size = 2
trim_trailing_whitespace = false trim_trailing_whitespace = false
max_line_length = 80
[*.{js,json,nix,yml,yaml,toml}] [*.{js,json,nix,yml,yaml,toml}]
indent_style = space indent_style = space

View file

@ -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
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