helle
54df89f601
Maintains compatibility with mdbook 0.4.x. Includes comments for what to remove once 0.5.x is the only we care about. Some other changes technically could be changed at that point, but currently serve to enable universal support of 0.4.x and 0.5.x Fixes #1051. Change-Id: Ic5b405038d180bcd357bbd9e5716879e0c26e5f5
43 lines
1.6 KiB
TOML
43 lines
1.6 KiB
TOML
[book]
|
|
title = "Lix Reference Manual"
|
|
|
|
[build]
|
|
create-missing = false
|
|
|
|
[output.html]
|
|
additional-css = ["custom.css"]
|
|
additional-js = ["redirects.js"]
|
|
# Jumps directly into a new Gerrit CL editing the file in question.
|
|
edit-url-template = "https://gerrit.lix.systems/admin/repos/edit/repo/lix/branch/main/file/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 substitute.py"
|
|
before = ["anchors", "links"]
|
|
|
|
[preprocessor.anchors]
|
|
renderers = ["html"]
|
|
command = "jq --from-file anchors.jq"
|
|
|
|
[output.markdown]
|
|
|
|
# XXX FUTURE: may be reenabled once mdBook 0.5.0 or above and matching mdbook-linkchecker are in nixpkgs
|
|
#[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"
|