mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-12-29 00:53:57 +00:00
a63b9c15c9
doc: add figure definition to bespoke syntax reference doc: add example definition to bespoke syntax reference doc: add footnote definition to beskpoke syntax reference The usage of footnotes in the manuals is not the one documented in markdown-it-py: https://python-markdown.github.io/extensions/footnotes/ doc: add inline comment definition to beskpoke syntax reference doc: add typographic replacements to beskpoke syntax reference doc: Fix rendering of bespoke syntax reference doc: remove references to DocBook in the NixOS manual doc: add entry on lack of HTML support doc: Minor improvement doc: update typographic replacements entry in beskpoke syntax reference doc: add link reference definitions to beskpoke syntax reference doc: fix footnote definition in beskpoke syntax reference doc: Minor improvements from code review Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io> Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
1.1 KiB
1.1 KiB
Writing NixOS Documentation
As NixOS grows, so too does the need for a catalogue and explanation of its extensive functionality. Collecting pertinent information from disparate sources and presenting it in an accessible style would be a worthy contribution to the project.
Building the Manual
The sources of the are in the
nixos/doc/manual
subdirectory of the Nixpkgs repository.
You can quickly validate your edits with make:
$ cd /path/to/nixpkgs/nixos/doc/manual
$ nix-shell
nix-shell$ devmode
Once you are done making modifications to the manual, it's important to build it before committing. You can do that as follows:
nix-build nixos/release.nix -A manual.x86_64-linux
When this command successfully finishes, it will tell you where the
manual got generated. The HTML will be accessible through the result
symlink at ./result/share/doc/nixos/index.html.