Linux 工具 - mdbook

在学习Rust的过程中，注意到大部分Rust在线书籍的形式都是一样的。Google后得知是通过mdbook工具生成的。mdbook是一个markdown文件在线文档工具。简单来说就是，将markdown文档转换为html格式。下面直接看一个示例：

下面通过一个示例来演示如何使用mdbook。下面是文档结构：

.
├── book.toml
└── src
    ├── chapter_1-1.md
    ├── chapter_1.md
    ├── chapter_2.md
    ├── end.md
    ├── preface.md
    └── SUMMARY.md

其中关键的两个文件book.toml 和 SUMMARY.md。

• book.toml 是配置文件。通过mdbook init会默认生成，使用默认的配置即可。

• SUMMARY.md 是文档结构排版文件。下面看一下文档内容立刻就直到怎么用了。

  # Summary
  
  [Preface](./preface.md)
  
  - [Chapter 1](./chapter_1.md)
      - [Chapter 1.1](./chapter_1-1.md)
  
  - [Chapter 2](./chapter_2.md)
  
  
  [End](./end.md)    
  

• 通过mdbook watch --open 命令即可在浏览器中进行预览。效果图：

  

参考

• mdBook
• github-mdBook