1
0
Fork 0
mirror of https://github.com/nix-community/home-manager synced 2024-09-21 13:57:31 +02:00
Commit graph

6 commits

Author SHA1 Message Date
Viktor Kronvall
e76d3e4d1a
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.
2024-04-10 21:26:50 +02:00
Viktor Kronvall
55a132124b
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`.
2024-04-10 21:26:50 +02:00
Viktor Kronvall
5381906852
docs: this is the home-manager manual 2024-04-10 21:26:48 +02:00
Viktor Kronvall
4da3b03b5b
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.
2024-04-10 21:26:48 +02:00
Viktor Kronvall
313c2a6416
docs: update paths to make manual tests pass 2024-04-10 21:26:47 +02:00
Viktor Kronvall
186fe307c2
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.
2024-04-10 21:26:46 +02:00