Convert manual to Markdown #3857
Conversation
Markdown doesn't have floats so we can't have this.
Pandoc silently ignores <simplesect>...
Pandoc doesn't know <replaceable> so let's force it to be rendered as italics.
Markdown doesn't support them.
|
While I acknowledge that this will lower the barrier to contribute to our manuals, shouldn't we wait until people came to an agreement in NixOS/rfcs#72 a majority is fine with? |
|
The lowdown page states (in a footnote):
|
This makes them available to 'nix repl'.
DummyStore does not allow building or adding paths. This is useful for evaluation tests when you don't want to initialize a "proper" store.
This can happen when using a dummy store (or indeed any non-local store).
|
Some more improvements:
|
|
Unless there are major objections I'd like to merge this (without prejudice to whatever markup language / tools people end up using for Nixpkgs/NixOS). Having a manpage for |
| if (evalSettings.pureEval) | ||
| throw EvalError("builtins.storePath' is not allowed in pure evaluation mode"); | ||
|
|
There was a problem hiding this comment.
It's been there before, but in a slightly different form.
There was a problem hiding this comment.
Committed directly to master lol 👨🍳💋
This PR converts the Nix manual from DocBook to Markdown.
The manual is currently rendered using
mdbook, which is a Rust tool used to format books like The Rust Programming Language. You can see the output here: https://hydra.nixos.org/job/nix/markdown/build.x86_64-linux/latest/download-by-type/doc/manualManpages are generated from Markdown using
lowdown. The output isn't great but it's good enough.Most of the conversion was done using Pandoc with some manual cleanups afterwards. Please let me know if you spot any conversion errors.