afeaa2371c
Folding by default would prevent things like "Ctrl+F for nix-env" from working trivially, but the user should be able to fold if they want to. Change-Id: I5273272289f0f24e1f040c691580acfe33f66bd4
42 lines
1.6 KiB
TOML
42 lines
1.6 KiB
TOML
[book]
|
|
title = "Lix Reference Manual"
|
|
|
|
[build]
|
|
create-missing = false
|
|
|
|
[output.html]
|
|
additional-css = ["custom.css"]
|
|
additional-js = ["redirects.js"]
|
|
# Using our GitHub mirror enables easier typo fixes since there is no easy way
|
|
# to just submit a Gerrit CL by the web for trivial stuff.
|
|
edit-url-template = "https://github.com/lix-project/lix/tree/main/doc/manual/{path}"
|
|
git-repository-url = "https://git.lix.systems/lix-project/lix"
|
|
# Folding by default would prevent things like "Ctrl+F for nix-env" from working
|
|
# trivially, but the user should be able to fold if they want to.
|
|
fold.enable = true
|
|
fold.level = 30
|
|
|
|
# Handles replacing @docroot@ with a path to ./src relative to that markdown file,
|
|
# {{#include handlebars}}, and the @generated@ syntax used within these. it mostly
|
|
# but not entirely replaces the links preprocessor (which we cannot simply use due
|
|
# to @generated@ files living in a different directory to make meson happy). we do
|
|
# not want to disable the links preprocessor entirely though because that requires
|
|
# disabling *all* built-in preprocessors and selectively reenabling those we want.
|
|
[preprocessor.substitute]
|
|
command = "python3 doc/manual/substitute.py"
|
|
before = ["anchors", "links"]
|
|
|
|
[preprocessor.anchors]
|
|
renderers = ["html"]
|
|
command = "jq --from-file doc/manual/anchors.jq"
|
|
|
|
[output.markdown]
|
|
|
|
[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"
|