Docket

Docket 是一个简单的 Markdown 到 HTML 文档渲染工具。Docket 旨在成为 d 的 Rust 克隆版。

主要特性

• 可安装的二进制文件，可以使用 cargo install 安装。
• 使用 Docopt 进行命令行参数解析。
• 使用 pulldown-cmark 进行 Markdown 渲染。
• 使用 Syntect 进行语法高亮。
• JavaScript 驱动的搜索。
• 零配置。

安装

可以使用 cargo 通过 cargo install docket 安装 Docket。安装后，您应该可以在命令行中以 docket 的形式运行它。

Docket 有两个默认启用的 Cargo 功能。如果您不需要它们，可以在安装时使用 --no-default-features 禁用它们以节省时间。

• watch - 支持监视文件并在更改时重新生成输出文件夹。
• par_render - 支持使用 Rayon crate 并行渲染页面。

入门

要开始创建文档，请在与您的存储库的根目录中创建一个新的 docs/ 文件夹。添加一个名为 index.md 的文件，其中包含项目的一个简短 Markdown 描述。通过在 docs/ 文件夹中创建新的 Markdown 文件来添加页面。每个页面都应该在开头有一个一级标题，该标题被视为页面的标题。

要渲染 HTML 输出，请切换到 docs/ 文件夹并运行 docket。这将创建一个新的 docs/build/ 文件夹，其中包含已渲染的站点；准备好发布到 Web 服务器或通过 GitHub Pages 提供服务。有关设置和配置的更多信息，请查看文档。