| Commit message (Collapse) | Author | Age |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| |
this adds support for structural includes to nixos-render-docs.
structural includes provide a way to denote the (sub)structure of the
nixos manual in the markdown source files, very similar to how we used
literal docbook blocks before, and are processed by nixos-render-docs
without involvement of xml tooling. this will ultimately allow us to
emit the nixos manual in other formats as well, e.g. html, without going
through docbook at all.
alternatives to this source layout were also considered:
a parallel structure using e.g. toml files that describe the document
tree and links to each part is possible, but much more complicated to
implement than the solution chosen here and makes it harder to follow
which files have what substructure. it also makes it much harder to
include a substructure in the middle of a file.
much the same goes for command-line arguments to the converter, only
that command-lined arguments are even harder to specify correctly and
cannot be reasonably pulled together from many places without involving
another layer of tooling. cli arguments would also mean that the manual
structure would be fixed in default.nix, which is also not ideal.
|
|
|
|
|
| |
userconfiguration.xml hasn't existed for a while, and this comment will
interfere with processing we'll be doing shortly.
|
|
|
|
|
|
| |
this should be placed before the appendices, not between them. might
even have a good place in the development part, but that's a decision
for another day.
|
|
|
|
| |
Also updates it to mention running md-to-db.sh.
|
|
|
|
|
|
|
| |
Instead of putting a README in the directory where the manual is
written, put the information from it straight in the docs themselves.
It's a bit untrivial to guess the manual is located exactly there for
contributers.
|
| |
|
|
|
|
|
| |
This reverts commit ea6e8775bd69e4676c623a85c39f1da540d29ad1. The new
format is not an improvement.
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
|
|
| |
hacking
|
| |
|
| |
|
|
|
|
|
|
|
|
|
| |
* manual: Mark commands that require root
Mark every command that requires to be run as root by prefixing them
with '#' instead of '$'.
* manual: Add note about commands that require root
|
| |
|
|
|
|
| |
Fixes #7607.
|
|
|
|
|
|
|
| |
I think this has been accidentally dropped by a099ca4, at least there is
no reason stated, why it shouldn't be included, so I'm bringing it back.
Signed-off-by: aszlig <aszlig@redmoonstudios.org>
|
|
|
|
| |
[Squashed commits to make git blame etc. more likely to work. -ED]
|
| |
|
| |
|
| |
|
| |
|
|
|
|
|
| |
In particular, this will make it clear what version of the manual is
shown at http://nixos.org/nixos/manual/.
|
| |
|
|
|