mirror of
https://github.com/NotAShelf/nvf.git
synced 2026-03-08 09:46:00 +00:00
Compare commits
4 commits
18c55d3beb
...
bebdddb571
| Author | SHA1 | Date | |
|---|---|---|---|
|
bebdddb571 |
|||
|
ab629c1995 |
|||
|
|
40c1ffab4a |
||
|
|
937b5a2fe9 |
3 changed files with 30 additions and 4 deletions
|
|
@ -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
|
||||||
|
|
|
||||||
|
|
@ -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