From 4fb8ed7dfef13afa8efce195c5fd4460db5f8787 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20S=C3=A1nchez=20Medina?= Date: Tue, 27 May 2025 00:29:06 +0200 Subject: [PATCH] doc/nrd: add example of multipage rendering --- pkgs/by-name/ni/nixos-render-docs/README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/pkgs/by-name/ni/nixos-render-docs/README.md b/pkgs/by-name/ni/nixos-render-docs/README.md index 5ef0faebcd79..a27e9fdbc9eb 100644 --- a/pkgs/by-name/ni/nixos-render-docs/README.md +++ b/pkgs/by-name/ni/nixos-render-docs/README.md @@ -75,3 +75,17 @@ In case this identifier is renamed, the mapping would change into: ] } ``` + +## Rendering multiple pages + +The `include` directive accepts an argument `into-file` to specify the file into which the imported markdown should be rendered to. We can use this argument to set up multipage rendering of the manuals. + +For example + +~~~ +```{=include=} appendix html:into-file=//release-notes.html +release-notes/release-notes.md +``` +~~~ + +will render the release notes into a `release-notes.html` file, instead of making it a section within the default `index.html`.