mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-17 07:13:23 +01:00
a8d4cf149c
Move the manpage-to-URL mapping to `doc/manpage-urls.json` so that we can reuse that file elsewhere, and generate the `link-manpages.lua` filter from that file. Also modify the Pandoc filter so that it doesn't wrap manpages that are already inside a link. Keeping a Lua filter is essential for speed: a Python filter would increase the runtime `md-to-db.sh` from ~20s to ~30s (but Python is not to blame; marshalling Pandoc types to and from JSON is a costly operation). Parsing in Lua seems tedious, so I went with the Nix way. |
||
|---|---|---|
| .. | ||
| build-aux/pandoc-filters | ||
| builders | ||
| contributing | ||
| doc-support | ||
| functions | ||
| hooks | ||
| languages-frameworks | ||
| old | ||
| stdenv | ||
| using | ||
| .gitignore | ||
| default.nix | ||
| functions.xml | ||
| Makefile | ||
| manpage-urls.json | ||
| manual.xml | ||
| overrides.css | ||
| preface.chapter.md | ||
| README.md | ||
| shell.nix | ||
| style.css | ||
Nixpkgs/doc
This directory houses the sources files for the Nixpkgs manual.
You can find the rendered documentation for Nixpkgs unstable on nixos.org.
Docs for Nixpkgs stable are also available.
If you want to contribute to the documentation, here's how to do it.
If you're only getting started with Nix, go to nixos.org/learn.