Jade Lovelace
cbaf1bb446
This is, well, interesting. It's the same "edit" button you see on Gitiles, and upon clicking it, without confirmation, it makes a new CL and dumps you directly into the editor for the file in question. I guess if you click it by accident you can just abandon or delete the CL so it's like, fine. A bit of fascinating UX design here. Change-Id: I765a1f1fc6d94b171878dde7b01fc621adc00180
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"]
|
|
# 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 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"
|