一款 Rust 福利工具 mdBook

mdBook 是一個從 Markdown 文件創建現代在線書籍的實用程序。

它是一個命令行工具。它非常適合創建產品或 API 文檔、教程、課程材料或任何需要乾淨、易於導航和自定義演示的內容。

它有以下特性：

• 輕量級 Markdown 語法可幫助您更加專注於內容

• 集成搜索支持

• 許多不同語言的代碼塊的顏色語法高亮顯示

• 主題文件允許自定義輸出的格式

• 預處理器可以爲自定義語法和修改內容提供擴展

• 後端可以將輸出呈現爲多種格式

• 以 Rust 編寫，以實現速度、安全性和簡單性

• Rust 代碼樣本的自動測試

mdBook 被 Rust 編程語言項目使用，《Rust 程序設計語言》一書就是 mdBook 的一個很好的例子。

安裝 mdBook 有多種方式，可以下載預編譯的二進制文件，也可以從源碼開始編譯。如果你安裝了 Rust，可以直接

cargo install mdbook

安裝完之後，你就可以使用它創建書籍了。

mdbook init 命令將創建一個新目錄，其中包含一本空書，供您開始使用。命令具體使用如下：

mdbook init my-first-book

在生成書籍之前它會詢問你一些問題。在生成之後，你可以切到新書籍的目錄：

cd my-first-book

這裏有幾種方法可以去渲染書籍，最簡單的方法之一就是使用 serve 命令，該命令將構建您的書籍並啓動本地 Web 服務器：

mdbook serve --open

--open 選項將打開默認的 Web 瀏覽器並查看您的新書。即使在編輯書籍內容時，也可以保持服務器運行，mdbook 將自動重建輸出並自動刷新到 web 瀏覽器。這樣你就可以實時查看編輯內容了。

一本在線書籍由以下幾個文件構成，這些文件定義了書的設置和佈局。

book.toml

在你的書的根目錄中，有一個 book.toml 文件，其中包含描述如何構建書的設置。這是用 TOML 標記語言編寫的。默認設置通常足夠好，可以讓您開始使用。如果您有興趣探索 mdBook 提供的更多功能和選項，請查看 “配置” 一章以瞭解更多詳細信息。

SUMMARY.md

書的下一個主要部分是摘要文件，位於 src/summary.md。該文件包含書中所有章節的列表。在章節可被查看之前，必須將其添加到此列表中。

源文件

你的書的內容都包含在 src 目錄中。每個章節都是一個單獨的 Markdown 文件。通常，每一章都以一個級別 1 的標題開頭，標題是該章的標題。

# 我的第一章
請在此處填寫您的內容。

文件的精確佈局由您決定。文件的組織將與生成的 HTML 文件相對應，因此請記住，文件佈局是每個章節 URL 的一部分。

在運行 mdbook serve 命令時，可以打開任何章節文件並開始編輯它們。每次保存文件時，mdbook 都會重新生成該書並刷新您的 web 瀏覽器。

src 目錄中的所有其他文件都將包含在輸出中。因此，如果您有圖像或其他靜態文件，只需將它們包含在 src 目錄中的某個位置即可。

發佈在線書籍

一旦你寫完了你的書，你可能想把它放在一個地方讓別人看。第一步是構建這本書的輸出。這可以在 book.toml 文件所在的同一目錄中使用 mdbook build 命令來完成：

mdbook build

這將生成一個名爲 book 的目錄，其中包含您的書的 HTML 內容。然後，您可以將此目錄放置在任何 web 服務器上以承載它。

如果你想寫一本在線書籍，快來試試 mdBook 吧。

想了解更多信息，請查閱 Github：

https://github.com/rust-lang/mdBook

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/N861_Rr2jQHZK-gswL7gAQ