handbook-en/book.toml

52 lines
1.5 KiB
TOML

[book]
authors = ["museum-digital"]
language = "en"
multilingual = false
src = "src"
title = "museum-digital:handbook"
description = "English language handbook for museum-digital"
[preprocessor.index]
[preprocessor.links]
[output.html.print]
enable = true
[output.html.fold]
enable = false
level = 0
[output.linkcheck]
# Should we check links on the internet? Enabling this option adds a
# non-negligible performance impact
follow-web-links = true
# Are we allowed to link to files outside of the book's root directory? This
# may help prevent linking to sensitive files (e.g. "../../../../etc/shadow")
traverse-parent-directories = true
# If necessary, you can exclude one or more links from being checked with a
# list of regular expressions. The regex will be applied to the link href (i.e.
# the `./index.html` in `[some page](./index.html)`) so it can be used to
# ignore both web and filesystem links.
#
# Hint: you can use TOML's raw strings (single quote) to avoid needing to
# escape things twice.
exclude = [ 'google\.com|php\.net' ]
# The User-Agent to use when sending web requests
# user-agent = "mdbook-linkcheck-0.4.0"
user-agent = "mdbook-linkcheck-0.4.0"
# The number of seconds a cached result is valid for (12 hrs by default)
cache-timeout = 43200
# How should warnings be treated?
#
# - "warn" will emit warning messages
# - "error" treats all warnings as errors, failing the linkcheck
# - "ignore" will ignore warnings, suppressing diagnostic messages and allowing
# the linkcheck to continuing
warning-policy = "warn"