mdbook

References

mdBook source code

mdBook docs

LaTeX 公式篇

MathJax support

Learn LaTeX in 30 minutes

一、Overview

mdBook is a command line tool to create books with Markdown.

rust language office book is write by mdbook docs

mdBook has so many advantages:

• Lightweight Markdown syntax helps you focus more on your content

• Integrated search support

• Color syntax highlighting for code blocks for many different languages

• Theme files allow customizing the formatting of the output

• Preprocessors can provide extensions for custom syntax and modifying content

• Backends can render the output to multiple formats

• Written in Rust for speed, safety, and simplicity

• Automated testing of Rust code samples

二、Basic Use

2.1 Install

	cargo install mdbook

2.2 Create a book

	mdbook init crafting-interpreters-zh

➜  blog-book git:(dev) ✗ mdbook init crafting-interpreters-zh

Do you want a .gitignore to be created? (y/n)
y
What title would you like to give the book?
crafting-interpreters-zh
2022-06-24 12:31:30 [INFO] (mdbook::book::init): Creating a new book with stub content

All done, no errors...

2.3 Run local

	mdbook serve
	

➜  blog-book git:(dev) ✗ cd crafting-interpreters-zh
➜  crafting-interpreters-zh git:(dev) ✗ mdbook serve
2022-06-24 12:35:30 [INFO] (mdbook::book): Book building has started
2022-06-24 12:35:30 [INFO] (mdbook::book): Running the html backend
2022-06-24 12:35:30 [INFO] (mdbook::cmd::serve): Serving on: http://localhost:3000
2022-06-24 12:35:30 [ERROR] (mdbook::cmd::serve): Unable to serve: panicked at 'error binding to 127.0.0.1:3000: error creating server listener: Address already in use (os error 48)', /Users/yz/.cargo/registry/src/mirrors.tuna.tsinghua.edu.cn-df7c3c540f42cdbd/warp-0.3.2/src/server.rs:213:27
➜  crafting-interpreters-zh git:(dev) ✗ mdbook serve -p 3001
2022-06-24 12:36:18 [INFO] (mdbook::book): Book building has started
2022-06-24 12:36:18 [INFO] (mdbook::book): Running the html backend
2022-06-24 12:36:18 [INFO] (mdbook::cmd::serve): Serving on: http://localhost:3001
2022-06-24 12:36:18 [INFO] (warp::server): Server::run; addr=127.0.0.1:3001
2022-06-24 12:36:18 [INFO] (warp::server): listening on http://127.0.0.1:3001
2022-06-24 12:36:18 [INFO] (mdbook::cmd::watch): Listening for changes...

2.4 Gen Static Files

	mdbook build
	

after exec command，there will add one directory named book in root directory，in which includes html/css/js static files

➜  crafting-interpreters-zh git:(dev) ✗ mdbook build
2022-06-24 13:01:19 [INFO] (mdbook::book): Book building has started
2022-06-24 13:01:19 [INFO] (mdbook::book): Running the html backend
➜  crafting-interpreters-zh git:(dev) ✗ ls
book      book.toml src
➜  crafting-interpreters-zh git:(dev) ✗ tree book
book
├── 404.html
├── FontAwesome
│   ├── css
│   │   └── font-awesome.css
│   └── fonts
│       ├── FontAwesome.ttf
│       ├── fontawesome-webfont.eot
	

三、Support Math Formula

mdbook support show Math Formula by MathJax

3.1 Set MathJax setting

[book]
authors = ["yz"]
language = "en"
multilingual = false
src = "src"
title = "learning-basic"

[output.html]
mathjax-support = true

注意⚠️

现在还不支持直接使用 $$ 作为分隔符，[] 分隔符需要额外添加一个反斜线 ,

当在公式中，需要使用双反斜线时候，还需要添加额外的两个反斜线

3.2 inline

行内的公式，使用 \\( 和 \\) 分隔，例如:

\(f(x) = a+b\)

一般在LaTex中，使用 $公式$ 实现。

表示行内

3.3 include line

行间公式，使用 \\[ 和 \\] 分隔，例如:

\[\mu = \frac{1}{N} \sum_{i=0} x_i \]

一般在LaTex中，使用 $$公式$$ 实现。

3.4 basic formula

(1) 手动编号， 命令 \tag{n} 可以进行手动编号

\[ f(x) = a + b - c \tag{1.1.2} \]

(2) 拉丁字母、阿拉伯数字、四则运算符都可以直接输入，

(3) 希腊字母和一些其他运算符