Home Explore Blog Models CI



nixpkgs

nixos/doc/manual/manual.md
3bef918f7ecc8a7f88eb136659ca42940270847aaed1434100000003000005dd
# NixOS Manual {#book-nixos-manual}
## Version @NIXOS_VERSION@

<!--
  this is the top-level structure file for the nixos manual.

  the manual structure extends the nixpkgs commonmark further with include
  blocks to allow better organization of input text. there are six types of
  include blocks: preface, parts, chapters, sections, appendix, and options.
  each type except `options`` corresponds to the docbook elements of (roughly)
  the same name, and can itself can further include blocks to denote its
  substructure.

  non-`options`` include blocks are fenced code blocks that list a number of
  files to include, in the form

     ```{=include=} <type>
     <file-name-1>
     <file-name-2>
     <...>
     ```

  `options` include blocks do not list file names but contain a list of key-value
  pairs that describe the options to be included and how to convert them into
  elements of the manual output type:

      ```{=include=} options
      id-prefix: <options id prefix>
      list-id: <variable list element id>
      source: <path to options.json>
      ```

-->

```{=include=} preface
preface.md
```

```{=include=} parts
installation/installation.md
configuration/configuration.md
administration/running.md
development/development.md
```

```{=include=} chapters
contributing-to-this-manual.chapter.md
```

```{=include=} appendix html:into-file=//options.html
nixos-options.md
```

```{=include=} appendix html:into-file=//release-notes.html
release-notes/release-notes.md
```

Chunks
8a816a20 (1st chunk of `nixos/doc/manual/manual.md`)
Title: NixOS Manual Structure and Content Organization
Summary
This chunk outlines the top-level structure of the NixOS Manual, detailing how content is organized using various 'include blocks'. These blocks, such as `preface`, `parts`, `chapters`, `sections`, `appendix`, and `options`, correspond to DocBook elements. Most block types include a list of markdown files, while `options` blocks specify key-value pairs for integrating system options data. The text then lists the specific files and sections to be included in the manual, such as installation, configuration, administration, development, contributing, NixOS options, and release notes.