aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/generate-manpage.nix
AgeCommit message (Collapse)Author
2023-09-06add anchors to option listingsValentin Gagarin
2023-08-02Add infra for experimental store implemenationsJohn Ericson
This is analogous to that for experimental settings and flags that we have also added as of late.
2023-05-03doc rendering: add functions to scope explicitly (#7378)Valentin Gagarin
* doc rendering: add functions to scope explicitly this especially helps beginners with code readability, since the origin of names is always immediately visible.
2023-04-16Add `optionalString` to manual Nix lang utilitiesJohn Ericson
Use it everywhere it could be also.
2023-04-14Start cross-referencing experimental featuresJohn Ericson
- Create a glossary entry for experimental features. - Have the man page experimental feature notice link `nix-commmand`. (Eventually this should be programmed, based on whether the command is experimental, and if so what experimental feature does it depend on.) - Document which installables depend on which experimental features. I tried to use the same style (bold warning and block quote) that the top of the man page uses. Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2023-03-23Make useAnchors a named argumentEelco Dolstra
2023-03-21Support per-store Markdown documentationEelco Dolstra
2023-03-21nix store --help: Include store type documentationEelco Dolstra
2023-03-21generate-manpage.nix: Make more readableEelco Dolstra
2022-11-30add missing newline, for consistent formattingValentin Gagarin
2022-10-07Print common flags in --helpAna Hobden
2022-09-30bring back lost newlineValentin Gagarin
2022-09-30use more self-explanatory namesValentin Gagarin
2022-09-30move final template to the topValentin Gagarin
this allows readers to enter the code starting with what is visible from the outside, instead of working themselves up from purely technical details.
2022-09-30remove superfluous let-in pairValentin Gagarin
2022-09-30refactor showOptionsValentin Gagarin
it was quite a pain to manipulate strings just with `builtins`
2022-09-30refactor rendering command documentation to markdownValentin Gagarin
idea: - make document structure visible, like in a template - order functions by descending abstraction - avoid nested let bindings
2022-09-30use indented strings where appropriateValentin Gagarin
2022-08-26do not render relative links in help pagesValentin Gagarin
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
2021-10-06Remove links to .md files in help outputEelco Dolstra
Fixes #5337.
2021-09-13nix --help: Display help using lowdown instead of manEelco Dolstra
Fixes #4476. Fixes #5231.
2021-02-17Restore warning about 'nix' being experimentalEelco Dolstra
Fixes #4552.
2021-01-25Group common optionsEelco Dolstra
2021-01-25Group subcommands by categoryEelco Dolstra
2020-12-23Command: Remove examples()Eelco Dolstra
2020-12-21generate-manpage.nix: Fix short namesEelco Dolstra
2020-12-03Make doc() return arbitrary Markdown rather than the contents of the ↵Eelco Dolstra
"Description" section Thus we can return the examples section (and any other sections) from doc() and don't need examples() anymore.
2020-12-02Put examples first in the manpagesEelco Dolstra
2020-12-02Generate separate manpages for each nix subcommandEelco Dolstra
2020-10-08Remove stray 'Title:' from the manualEelco Dolstra
Closes #4096.
2020-09-16jq -> nixEelco Dolstra