nixos/doc/manual/manual.md

   1 # NixOS Manual {#book-nixos-manual}
   2 ## Version @NIXOS_VERSION@
   3
   4 <!--
   5   this is the top-level structure file for the nixos manual.
   6
   7   the manual structure extends the nixpkgs commonmark further with include
   8   blocks to allow better organization of input text. there are six types of
   9   include blocks: preface, parts, chapters, sections, appendix, and options.
  10   each type except `options`` corresponds to the docbook elements of (roughly)
  11   the same name, and can itself can further include blocks to denote its
  12   substructure.
  13
  14   non-`options`` include blocks are fenced code blocks that list a number of
  15   files to include, in the form
  16
  17      ```{=include=} <type>
  18      <file-name-1>
  19      <file-name-2>
  20      <...>
  21      ```
  22
  23   `options` include blocks do not list file names but contain a list of key-value
  24   pairs that describe the options to be included and how to convert them into
  25   elements of the manual output type:
  26
  27       ```{=include=} options
  28       id-prefix: <options id prefix>
  29       list-id: <variable list element id>
  30       source: <path to options.json>
  31       ```
  32
  33 -->
  34
  35 ```{=include=} preface
  36 preface.md
  37 ```
  38
  39 ```{=include=} parts
  40 installation/installation.md
  41 configuration/configuration.md
  42 administration/running.md
  43 development/development.md
  44 ```
  45
  46 ```{=include=} chapters
  47 contributing-to-this-manual.chapter.md
  48 ```
  49
  50 ```{=include=} appendix html:into-file=//options.html
  51 nixos-options.md
  52 ```
  53
  54 ```{=include=} appendix html:into-file=//release-notes.html
  55 release-notes/release-notes.md
  56 ```