alois31/lix
0
0
Fork 0
forked from lix-project/lix
Code Pull requests Activity
lix/doc/manual/book.toml

32 lines
1 KiB
TOML
Raw Normal View History

doc/book.toml: Improve config (#7300) * doc/book.toml: Improve config - `title` value will be added to the HTML <title> - here</title> - `git-repository-url` adds a link to the GitHub repo in the top right corner - `edit-url-template` adds an edit link, inviting contributions Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-20 15:29:32 +00:00
[book]
title = "Nix Reference Manual"
Improve margins between sections The default CSS puts almost no space between sections, but a lot of space between subsections. This flips that around.
2020-08-19 10:31:18 +00:00
[output.html]
additional-css = ["custom.css"]
doc: Add redirects for the DocBook manual There are still many links to the old manual on the web and having them end up on the Introduction page is a bad user experience.
2022-05-25 06:07:02 +00:00
additional-js = ["redirects.js"]
doc/book.toml: Improve config (#7300) * doc/book.toml: Improve config - `title` value will be added to the HTML <title> - here</title> - `git-repository-url` adds a link to the GitHub repo in the top right corner - `edit-url-template` adds an edit link, inviting contributions Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
2022-12-20 15:29:32 +00:00
edit-url-template = "https://github.com/NixOS/nix/tree/master/doc/manual/{path}"
git-repository-url = "https://github.com/NixOS/nix"
doc: Introduce pre-processor for adding anchors to text It is now possible to use the following syntax to insert anchors into the text: []{#anchor-name} The anchor will allow linking to the location it is placed by appending #anchor-name to the URL. Additionally, it is possible to create a link pointing to its own location by adding text between the square brackets: [`--add-root`]{#opt-add-root}
2022-05-25 16:51:04 +00:00
docs: replace sed invocation with an mdbook preprocessor for @docroot@ We're not entirely clear on why the links preprocessor has to be done *before* rather than after, but we assume it is probably that as a builtin preprocessor it does some processing on the raw book source, and not just the JSON data. Also a real use for Python pattern matching? I know I was surprised too. Change-Id: Ibe8b59e7b5bd5f357a655d8b4c5f0b0f58a67d6b
2024-04-02 23:01:53 +00:00
# Handles replacing @docroot@ with a path to ./src relative to that markdown file.
[preprocessor.docroot]
renderers = ["html", "linkcheck"]
command = "python3 doc/manual/docroot.py"
# I would have thought that @docroot@ replacement had to be done *before*
# the link preprocessor gets its hands on this book, but nope it's actually
# the opposite.
after = ["links"]
docs: skip do custom include processing for mdbook mdbook already does include processing of its own, and the custom processing code has always admitted as much. we don't need it for the mdbook build at this point if we run our preprocessors in the right order, and maybe we can even have mdbook to return complete pages to us that we only have to pass to lowdown without any more preprocessing of our own. Change-Id: Icd978acbc3b1e215fee8f062c53ab2cb2a222ab1
2024-04-08 02:55:18 +00:00
before = ["anchors"]
docs: replace sed invocation with an mdbook preprocessor for @docroot@ We're not entirely clear on why the links preprocessor has to be done *before* rather than after, but we assume it is probably that as a builtin preprocessor it does some processing on the raw book source, and not just the JSON data. Also a real use for Python pattern matching? I know I was surprised too. Change-Id: Ibe8b59e7b5bd5f357a655d8b4c5f0b0f58a67d6b
2024-04-02 23:01:53 +00:00
doc: Introduce pre-processor for adding anchors to text It is now possible to use the following syntax to insert anchors into the text: []{#anchor-name} The anchor will allow linking to the location it is placed by appending #anchor-name to the URL. Additionally, it is possible to create a link pointing to its own location by adding text between the square brackets: [`--add-root`]{#opt-add-root}
2022-05-25 16:51:04 +00:00
[preprocessor.anchors]
doc: Port anchors preprocessor to jq script Python is only pulled into the build closure by Mercurial, which might end up being removed. Let’s port the script to jq, which is more likely to stay.
2022-05-26 14:47:40 +00:00
renderers = ["html"]
command = "jq --from-file doc/manual/anchors.jq"
manual: Check links mdbook-linkcheck is not consistent about its warning setting. It disables some warnings, but not the warnings about lack of fragment checking support; hence the extra filtering.
2023-01-03 07:53:29 +00:00
[output.linkcheck]
# no Internet during the build (in the sandbox)
follow-web-links = false
# mdbook-linkcheck does not understand [foo]{#bar} style links, resulting in
# excessive "Potential incomplete link" warnings. No other kind of warning was
# produced at the time of writing.
warning-policy = "ignore"
Copy permalink