import this
1e01a8e633
* add changelog for new release * add more URLs redirection for socks5 specific apps * update exit policy page * finish changelog - ready for review * add tooling * clarify tornul note comment
118 lines
4.4 KiB
TOML
118 lines
4.4 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 portugese, spanish next
|
|
src = "src"
|
|
|
|
[rust]
|
|
edition = "2018"
|
|
|
|
#################
|
|
# PREPROCESSORS #
|
|
#################
|
|
|
|
[preprocessor.theme]
|
|
pagetoc = true
|
|
sidebar-width = "280px"
|
|
content-max-width = "80%"
|
|
root-font-size = "70%"
|
|
# if you need to change anything in the index.hbs file you need to turn this to `false`, rebuild the book,
|
|
# probably remove the additional `comment` that gets appended to the header, and then change this back to `true`.
|
|
# this is because of a bug in the `mdbook-theme` plugin
|
|
turn-off = true
|
|
|
|
[preprocessor.admonish]
|
|
command = "mdbook-admonish"
|
|
assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
|
|
|
|
# https://gitlab.com/tglman/mdbook-variables/
|
|
[preprocessor.variables.variables]
|
|
minimum_rust_version = "1.66"
|
|
wallet_release_version = "1.2.8"
|
|
# nym-vpn related variables
|
|
nym_vpn_latest_binary_url = "https://github.com/nymtech/nym/releases/tag/nym-vpn-alpha-0.0.3"
|
|
nym_vpn_form_url = "https://opnform.com/forms/nymvpn-user-research-at-37c3-yccqko-2"
|
|
|
|
[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 = "themes"
|
|
default-theme = "coal"
|
|
preferred-dark-theme = "coal"
|
|
curly-quotes = true
|
|
copy-fonts = true
|
|
no-section-label = false
|
|
additional-css = [
|
|
"./themes/custom.css",
|
|
"./themes/mdbook-admonish.css",
|
|
"./themes/pagetoc.css",
|
|
]
|
|
additional-js = ["./themes/pagetoc.js"]
|
|
git-repository-url = "https://github.com/nymtech/nym/documentation/"
|
|
git-repository-icon = "fa-github"
|
|
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 = true # 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"
|
|
|
|
[output.html.redirect]
|
|
"/sdk/rust/examples/socks.html" = "https://nymtech.net/developers/sdk/rust/examples/socks.html"
|
|
"/clients/overview.html" = "https://nymtech.net/developers/clients-overview.html"
|
|
"/sdk/rust/rust.html" = "https://nymtech.net/developers/sdk/rust/rust.html"
|
|
"/clients/socks5-client.html" = "https://nymtech.net/developers/clients/socks5-client.html"
|
|
"/clients/webassembly-client.html" = "https://nymtech.net/developers/clients/webassembly-client.html"
|
|
"/sdk/typescript.html" = "https://sdk.nymtech.net"
|
|
"/clients/websocket-client.html" = "https://nymtech.net/developers/clients/websocket-client.html"
|
|
"/use-apps/blockstream-green" = "https://nymtech.net/developers/clients/socks5/usage.html"
|
|
"/use-apps/telegram" = "https://nymtech.net/developers/archive/nym-connect.html#telegram-via-nymconnect"
|
|
|