1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-12-25 19:29:47 +01:00
Commit graph

13 commits

Author SHA1 Message Date
Sandro
d47d33254f
home-manager-manual: expose options.json 2024-10-10 20:29:24 +02:00
Mario Rodas
8bdb74eaff
docs: add redirect from the previous options.html
After migrating to nixos-render-docs, the extension move to .xtml.
Unfortunately, this broke links to the previous Options Page.

This patch provides a basic redirect support to the new Options Page.
2024-06-09 13:09:00 +02:00
Robert Helgesson
2db6a2a429
docs: add style sheets and scrubDerivations
This adds style sheets and `scrubDerivations` from nmd, thereby
removing the need to download them separately.
2024-02-01 01:10:58 +01:00
Viktor Kronvall
07754e935a docs: add considerate as maintainer 2023-12-16 15:49:45 +09:00
Viktor Kronvall
6fc71dc563 docs: add release-notes as appendix
The release notes used to be an appendix in the manual. After
converting to markdown that appendix got lost. This commit
reintroduces the release notes into the manual.
2023-12-16 15:46:00 +09:00
Robert Helgesson
fa91c109b0
docs: use relative paths to static resources
Fixes #4753
2023-12-09 13:20:54 +01:00
Robert Helgesson
f10eb1b3ee
docs: apply nixfmt 2023-12-09 09:05:16 +01:00
Viktor Kronvall
613dbb35db docs: rename generated manual to index.xhtml
The `nixos-render-docs` tool outputs XHTML formatted content. In
order to convince browsers like `firefox` to treat the data as XHTML
the extension must be `.xhtml` and not `.html`.

Using the XHTML-formatted content as HTML is mainly an issue with
self-closing `<a />` tags.
2023-12-07 21:40:31 +09:00
Viktor Kronvall
0a71046493 docs: fix syntax highlighting
`document-highlighter` now outputs a `<code>` block inside the
pre-formatted `<pre>` tag. This changes the required CSS for
rendering code snippets. Moreover, this commit uses the highlightjs
as provided by the `document-highlighter` package instead of the
version packaged in `nmd`.
2023-12-07 21:31:50 +09:00
Viktor Kronvall
b5a47bd700 docs: this is the home-manager manual 2023-12-07 21:28:18 +09:00
Viktor Kronvall
8dae2041ef docs: use nixos-render-docs
This commit removes the `home-manager-render-docs` package in favor
of upstream `nixos-render-docs` where the manpage generator has been
updated to take a `--header` and a `--footer` flag specifying static
content around the content derived from the options.json file.
2023-12-07 21:28:16 +09:00
Viktor Kronvall
f48a0062df docs: update paths to make manual tests pass 2023-12-07 21:27:38 +09:00
Viktor Kronvall
80ac72bf03 docs: render without deprecated optionsDocBook
The `optionsDocBook` function is deprecated in nixpkgs since
nixos-23.11. This commit updates the manual and manpages to
use commonmark formatted documentation instead of the deprecated
docbook format.
2023-12-07 21:27:38 +09:00