Valentin Gagarin
4655563470
refactor rendering command documentation to markdown
...
idea:
- make document structure visible, like in a template
- order functions by descending abstraction
- avoid nested let bindings
2022-09-30 01:42:46 +02:00
Valentin Gagarin
6b56bb4a79
use indented strings where appropriate
2022-09-30 01:42:46 +02:00
Valentin Gagarin
e7dcacbd7c
do not render relative links in help pages
...
this simplifies the setup a lot, and avoids weird looking `./file.md`
links showing up.
it also does not show regular URLs any more. currently the command
reference only has few of them, and not showing them in the offline
documentation is hopefully not a big deal.
instead of building more special-case solutions, clumsily preprocessing
the input, or issuing verbal rules on dealing with URLs, should better
be solved sustainably by not rendering relative links in `lowdown`:
https://github.com/kristapsdz/lowdown/issues/105
2022-08-26 17:10:41 +02:00
Eelco Dolstra
08aa7daee0
Remove links to .md files in help output
...
Fixes #5337 .
2021-10-06 13:01:18 +02:00
Eelco Dolstra
49a932fb18
nix --help: Display help using lowdown instead of man
...
Fixes #4476 .
Fixes #5231 .
2021-09-13 14:45:21 +02:00
Eelco Dolstra
6042febfce
Restore warning about 'nix' being experimental
...
Fixes #4552 .
2021-02-17 15:30:49 +01:00
Eelco Dolstra
36c4d6f592
Group common options
2021-01-25 19:03:13 +01:00
Eelco Dolstra
807d963ee8
Group subcommands by category
2021-01-25 18:19:32 +01:00
Eelco Dolstra
1047cb1e53
Command: Remove examples()
2020-12-23 18:26:40 +01:00
Eelco Dolstra
9dcd0aebc5
generate-manpage.nix: Fix short names
2020-12-21 13:32:27 +01:00
Eelco Dolstra
c3c858ac6d
Make doc() return arbitrary Markdown rather than the contents of the "Description" section
...
Thus we can return the examples section (and any other sections) from
doc() and don't need examples() anymore.
2020-12-03 16:17:58 +01:00
Eelco Dolstra
e2efc63979
Put examples first in the manpages
2020-12-02 23:23:23 +01:00
Eelco Dolstra
72428e38d9
Generate separate manpages for each nix subcommand
2020-12-02 23:23:23 +01:00
Eelco Dolstra
58dadf2954
Remove stray 'Title:' from the manual
...
Closes #4096 .
2020-10-08 17:30:40 +02:00
Eelco Dolstra
39bc49318f
jq -> nix
2020-09-16 14:58:06 +02:00
