以类似于 GitHub 等方式渲染 README 文件

为 lib.rs 提供 README 到 HTML 转换。它主要是内部的

支持

• Markdown (在 Rust 中原生支持) 和
• reStructuredText (通过 rst2html)，
• 支持使用 Sublime Text 语法定义进行语法高亮。
  • 仅生成 <span class>。实际的主题颜色在 style 子项目 中。
• 针对 Rust 语言和 Rust 库有 twreaks 和 hacks，因此例如如果它无法检测到使用的语言，则会回退到 Rust 语法。

安装

安装 docutils 包，以便 rst2html 命令可用（在 PATH 中）。

它需要将文件写入系统的临时目录以供 rst2html 使用。如果您在程序运行时清除临时文件，rst 支持可能会失败。

制作主题

它根据 Sublime 语法文件的命名空间名称生成 HTML <span> 类名，但

• 用于命名空间的单词被缩写。有关缩写列表，请参阅 highlight.rs。
• 仅添加具有 2 和 3 级别的命名空间（更具体的命名空间被截断到前三个单词）。

添加更多语言

所有语言都预先编译自 syntaxes/ 子模块。

tmLanguage 定义需要首先 进行转换。