ethrex/book.toml at main · qu0b/ethrex · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
[book]
authors = ["lambdaclass"]
language = "en"
src = "docs"
title = "Ethrex"

[rust]
edition = "2024"

# To render GitHub style alerts
# https://github.com/lambdalisue/rs-mdbook-alerts
[preprocessor.alerts]
# This is to avoid warnings about incomplete links on each alert
renderers = ["html", "linkcheck"]

# To render Mermaid diagrams
# https://github.com/badboy/mdbook-mermaid
[preprocessor.mermaid]
command = "mdbook-mermaid"

# To render LaTeX math expressions
# Note: Warnings can be safely ignored
# https://github.com/lzanini/mdbook-katex
[preprocessor.katex]
after = ["links"]

[output.html]
git-repository-url = "https://github.com/lambdaclass/ethrex"
# make sections collapsible, and start with everything collapsed
fold = { enable = true, level = 0 }
# Required for mdbook-mermaid
additional-js = ["mermaid.min.js", "mermaid-init.js"]

# keep README links working in mdBook output
[output.html.redirect]
"/getting-started/README.html" = "/getting-started/index.html"
"/getting-started/installation/README.html" = "/getting-started/installation/index.html"
"/l1/running/README.html" = "/l1/running/index.html"
"/developers/l1/testing/README.html" = "/developers/l1/testing/index.html"
"/l2/fundamentals/README.html" = "/l2/fundamentals/index.html"
"/l2/architecture/README.html" = "/l2/architecture/index.html"

# Broken-link checker
# https://github.com/Michael-F-Bryan/mdbook-linkcheck
# Needs to be installed with `cargo install mdbook-linkcheck`
[output.linkcheck]
optional = true