mirror of https://github.com/NixOS/nixpkgs.git synced 2024-11-23 15:33:13 +00:00

pennae 1229e735ac nixos-render-docs: add structural includes, use for manual

this adds support for structural includes to nixos-render-docs.
structural includes provide a way to denote the (sub)structure of the
nixos manual in the markdown source files, very similar to how we used
literal docbook blocks before, and are processed by nixos-render-docs
without involvement of xml tooling. this will ultimately allow us to
emit the nixos manual in other formats as well, e.g. html, without going
through docbook at all.

alternatives to this source layout were also considered:

a parallel structure using e.g. toml files that describe the document
tree and links to each part is possible, but much more complicated to
implement than the solution chosen here and makes it harder to follow
which files have what substructure. it also makes it much harder to
include a substructure in the middle of a file.

much the same goes for command-line arguments to the converter, only
that command-lined arguments are even harder to specify correctly and
cannot be reasonably pulled together from many places without involving
another layer of tooling. cli arguments would also mean that the manual
structure would be fixed in default.nix, which is also not ideal.

2023-02-12 13:02:42 +01:00

728 B

Raw Blame History

Configuration

This chapter describes how to configure various aspects of a NixOS machine through the configuration file {file}/etc/nixos/configuration.nix. As described in , changes to this file only take effect after you run {command}nixos-rebuild.

config-syntax.chapter.md
package-mgmt.chapter.md
user-mgmt.chapter.md
file-systems.chapter.md
x-windows.chapter.md
wayland.chapter.md
gpu-accel.chapter.md
xfce.chapter.md
networking.chapter.md
linux-kernel.chapter.md
subversion.chapter.md

@MODULE_CHAPTERS@

profiles.chapter.md
kubernetes.chapter.md

728 B Raw Blame History

Configuration

728 B

Raw Blame History