Commit graph

10 commits

Author SHA1 Message Date
Viktor Kronvall
34ccacf798
docs: add considerate as maintainer
(cherry picked from commit 07754e935a)
2023-12-17 13:04:14 +01:00
Viktor Kronvall
052d8a681f
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.

(cherry picked from commit 6fc71dc563)
2023-12-17 13:03:39 +01:00
Robert Helgesson
71d9bd6724 docs: use relative paths to static resources
Fixes #4753
2023-12-09 22:23:51 +09:00
Robert Helgesson
890239846e docs: apply nixfmt 2023-12-09 22:23:46 +09:00
Viktor Kronvall
93e2536db2 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-09 01:07:08 +09:00
Viktor Kronvall
0da5767319 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-09 01:07:08 +09:00
Viktor Kronvall
5d63a01440 docs: this is the home-manager manual 2023-12-09 01:07:08 +09:00
Viktor Kronvall
cc48491bfc 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-09 01:07:00 +09:00
Viktor Kronvall
7bd59cb10c docs: update paths to make manual tests pass 2023-12-09 01:06:44 +09:00
Viktor Kronvall
69a96783b1 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-09 01:06:44 +09:00