nixpkgs/doc
2023-11-28 16:48:10 +02:00
..
build-helpers doc: builders -> build helpers to reduce ambigualty 2023-11-07 19:58:53 +00:00
contributing doc/vulnerability-roundup: Rough move to new contribution doc files 2023-08-13 22:04:56 +02:00
development CONTRIBUTING.md: Move opening issues section to Nixpkgs manual 2023-08-13 22:04:57 +02:00
doc-support doc: Render lib.fixedPoints 2023-07-08 18:46:08 +02:00
functions lib.fileset: Move introduction section above the functions 2023-11-19 15:00:57 +01:00
hooks Merge master into staging-next 2023-11-14 18:01:11 +00:00
languages-frameworks buildNimPackage: load lockfiles and overrides 2023-11-28 16:48:10 +02:00
module-system lib.modules: configurationClass -> class 2023-05-06 18:32:59 +02:00
old doc: fix typos 2022-12-17 18:21:48 -05:00
packages darwin.linuxBuilder: Fix working directory in documentation 2023-11-25 20:35:45 -08:00
stdenv doc/stdenv: update manual phases execution instructions 2023-11-20 00:06:11 +01:00
using treewide: fix redirected and broken URLs 2023-11-11 10:49:01 +01:00
build-helpers.md doc: add introduction to build helpers 2023-11-07 19:58:54 +00:00
common.nix nixpkgs manual: extract some build paths 2023-07-25 17:00:51 +07:00
contributing.md doc: render nixpkgs manual with nrd 2023-07-01 20:59:29 +02:00
default.nix doc: Add lib.meta to the library functions ToC 2023-11-04 11:24:19 -04:00
development.md CONTRIBUTING.md: Move opening issues section to Nixpkgs manual 2023-08-13 22:04:57 +02:00
functions.md lib.fileset: Move introduction section above the functions 2023-11-19 15:00:57 +01:00
lib.md doc: render nixpkgs manual with nrd 2023-07-01 20:59:29 +02:00
manpage-urls.json nixos/xdg/portal: Add config and configPackages option 2023-11-21 08:42:10 +01:00
manual.md.in doc: builders -> build helpers to reduce ambigualty 2023-11-07 19:58:53 +00:00
overrides.css
preface.chapter.md doc: remove mention of X11 license variant (#255081) 2023-09-14 18:08:25 +02:00
README.md doc: separate commit header conventions for each area, info on docs changes. 2023-11-13 20:41:08 -08:00
shell.nix nixpkgs/NixOS manuals: devmode feature 2023-07-25 17:03:15 +07:00
stdenv.md doc: render nixpkgs manual with nrd 2023-07-01 20:59:29 +02:00
style.css
using-nixpkgs.md doc: minimal documentation of supported platforms 2023-10-02 21:21:56 +02:00

Contributing to the Nixpkgs manual

This directory houses the sources files for the Nixpkgs manual.

You can find the rendered documentation for Nixpkgs unstable on nixos.org. The rendering tool is nixos-render-docs, sometimes abbreviated nrd.

Docs for Nixpkgs stable are also available.

If you're only getting started with Nix, go to nixos.org/learn.

Contributing to this documentation

You can quickly check your edits with nix-build:

$ cd /path/to/nixpkgs
$ nix-build doc

If the build succeeds, the manual will be in ./result/share/doc/nixpkgs/manual.html.

devmode

The shell in the manual source directory makes available a command, devmode. It is a daemon, that:

  1. watches the manual's source for changes and when they occur — rebuilds
  2. HTTP serves the manual, injecting a script that triggers reload on changes
  3. opens the manual in the default browser

Syntax

As per RFC 0072, all new documentation content should be written in CommonMark Markdown dialect.

Additional syntax extensions are available, all of which can be used in NixOS option documentation. The following extensions are currently used:

Tables

Tables, using the GitHub-flavored Markdown syntax.

Anchors

Explicitly defined anchors on headings, to allow linking to sections. These should be always used, to ensure the anchors can be linked even when the heading text changes, and to prevent conflicts between automatically assigned identifiers.

It uses the widely compatible header attributes syntax:

## Syntax {#sec-contributing-markup}

Note

NixOS option documentation does not support headings in general.

Inline Anchors

Allow linking arbitrary place in the text (e.g. individual list items, sentences…).

They are defined using a hybrid of the link syntax with the attributes syntax known from headings, called bracketed spans:

- []{#ssec-gnome-hooks-glib} `glib` setup hook will populate `GSETTINGS_SCHEMAS_PATH` and then `wrapGAppsHook` will prepend it to `XDG_DATA_DIRS`.

If you omit a link text for a link pointing to a section, the text will be substituted automatically. For example [](#chap-contributing).

This syntax is taken from MyST.

Roles

If you want to link to a man page, you can use {manpage}`nix.conf(5)`. The references will turn into links when a mapping exists in doc/manpage-urls.json.

A few markups for other kinds of literals are also available:

  • {command}`rm -rfi`
  • {env}`XDG_DATA_DIRS`
  • {file}`/etc/passwd`
  • {option}`networking.useDHCP`
  • {var}`/etc/passwd`

These literal kinds are used mostly in NixOS option documentation.

This syntax is taken from MyST. Though, the feature originates from reStructuredText with slightly different syntax.

Admonitions

Set off from the text to bring attention to something.

It uses pandocs fenced divs syntax:

::: {.warning}
This is a warning
:::

The following are supported:

Definition lists

For defining a group of terms:

pear
:   green or yellow bulbous fruit

watermelon
:   green fruit with red flesh

Commit conventions

  • Make sure you read about the commit conventions common to Nixpkgs as a whole.

  • If creating a commit purely for documentation changes, format the commit message in the following way:

    doc: (documentation summary)
    
    (Motivation for change, relevant links, additional information.)
    

    Examples:

    • doc: update the kernel config documentation to use nix-shell

    • doc: add information about nix-update-script

      Closes #216321.

  • If the commit contains more than just documentation changes, follow the commit message format relevant for the rest of the changes.