mfahampshire
125 lines
4.5 KiB
TOML
125 lines
4.5 KiB
TOML
[book]
|
|
title = "Nym Docs"
|
|
authors = ["Max Hampshire, Serinko, Alexia Lorenza Martinel"]
|
|
description = "Nym technical documentation"
|
|
language = "en"
|
|
multilingual = false # for the moment - ideally work on chinese, brazillian, spanish next
|
|
src = "src"
|
|
|
|
[rust]
|
|
edition = "2018"
|
|
|
|
#################
|
|
# PREPROCESSORS #
|
|
#################
|
|
|
|
# Note if changing these fields:
|
|
# - make sure you aren't running `mdbook serve`
|
|
# - change value of `turn-off = true` to `false`. This is set to `true` usually to avoid a known constant-reload bug with `mdbook serve` and this preprocessor
|
|
# - delete `./theme/` dir
|
|
# - change the preprocessor values that you want to edit
|
|
# - run `mdbook build`: this will rebuild the `./theme` directory
|
|
# - change value of `turn-off` back to `true`
|
|
[preprocessor.theme]
|
|
pagetoc = true
|
|
# some variables related (defined in theme/css/variables.css)
|
|
pagetoc-width = "13%"
|
|
content-max-width = "70%" # 82
|
|
pagetoc-fontsize = "14.5px"
|
|
sidebar-width = "300px"
|
|
menu-bar-height = "40px" # memu-bar = the bar on the top
|
|
page-padding = "20px"
|
|
mobile-content-max-width = "98%"
|
|
|
|
# layout
|
|
content-padding = "0 10px"
|
|
content-main-margin-left = "10%"
|
|
content-main-margin-right = "10%"
|
|
nav-chapters-max-width = "auto"
|
|
nav-chapters-min-width = "auto"
|
|
chapter-line-height = "2em"
|
|
section-line-height = "1.5em"
|
|
|
|
# if true, never read and touch the files in theme dir: this is used to stop the looping reload issue referred to in the readme
|
|
turn-off = true
|
|
|
|
[preprocessor.admonish]
|
|
command = "mdbook-admonish"
|
|
assets_version = "3.0.0" # do not edit: managed by `mdbook-admonish install`
|
|
|
|
# variables preprocessor: import variables into files
|
|
# https://gitlab.com/tglman/mdbook-variables/
|
|
[preprocessor.variables.variables]
|
|
minimum_rust_version = "1.66"
|
|
wallet_release_version = "1.2.8"
|
|
|
|
[preprocessor.last-changed]
|
|
command = "mdbook-last-changed"
|
|
renderer = ["html"]
|
|
|
|
# used for grabbing output of binary commands for automation
|
|
# https://github.com/FauconFan/mdbook-cmdrun
|
|
[preprocessor.cmdrun]
|
|
|
|
# more pre-processor plugins to look into from https://github.com/rust-lang/mdBook/wiki/Third-party-plugins & https://lib.rs/keywords/mdbook-preprocessor
|
|
# mdbook-i18n
|
|
|
|
#########
|
|
# BUILD #
|
|
#########
|
|
|
|
[build]
|
|
build-dir = "book" # the directory where the output is placed
|
|
create-missing = true # whether or not to create missing pages
|
|
use-default-preprocessors = true # use the default preprocessors
|
|
extra-watch-dirs = [] # directories to watch for triggering builds
|
|
|
|
##########
|
|
# OUTPUT #
|
|
##########
|
|
|
|
[output.html]
|
|
theme = "theme" # this is the default if not explicitly set
|
|
default-theme = "coal"
|
|
preferred-dark-theme = "coal"
|
|
curly-quotes = true
|
|
# mathjax-support = false # useful if we want to pull equations in
|
|
copy-fonts = true
|
|
no-section-label = false
|
|
additional-css = ["theme/pagetoc.css", "././mdbook-admonish.css", "./custom.css", "./mdbook-admonish.css"]
|
|
additional-js = ["theme/pagetoc.js"]
|
|
git-repository-url = "https://github.com/nymtech/nym"
|
|
git-repository-icon = "fa-github"
|
|
# edit-url-template = "https://github.com/rust-lang/mdBook/edit/master/guide/{path}"
|
|
# site-url = "/docs/"
|
|
# cname = "nymtech.net"
|
|
input-404 = "not-found.md"
|
|
|
|
[output.html.fold]
|
|
enable = true # whether or not to enable section folding
|
|
level = 0 # the depth to start folding
|
|
|
|
# controlling rust sample code blocks
|
|
[output.html.playground]
|
|
editable = false # allows editing the source code
|
|
copyable = true # include the copy button for copying code snippets
|
|
copy-js = true # includes the JavaScript for the code editor
|
|
line-numbers = false # displays line numbers for editable code
|
|
runnable = true # displays a run button for rust code
|
|
|
|
# options for the built in text search
|
|
[output.html.search]
|
|
enable = true # enables the search feature
|
|
limit-results = 30 # maximum number of search results
|
|
teaser-word-count = 30 # number of words used for a search result teaser
|
|
use-boolean-and = true # multiple search terms must all match
|
|
boost-title = 2 # ranking boost factor for matches in headers
|
|
boost-hierarchy = 1 # ranking boost factor for matches in page names
|
|
boost-paragraph = 1 # ranking boost factor for matches in text
|
|
expand = true # partial words will match longer terms
|
|
heading-split-level = 3 # link results to heading levels
|
|
copy-js = true # include Javascript code for search
|
|
|
|
[output.linkcheck]
|
|
warning-policy = "warn"
|