Lib.rs

termbook是一个命令行工具，在执行代码块并收集它们的输出以成为mdbook的一部分时构建mdbook。

这允许为命令行界面编写可测试的文档。

它是为了满足share-secrets-safely的文档需求而诞生的。

安装

安装文档可以在这里找到。

文档

termbook使用termbook来编写自己的文档。点击这里了解更多！

路线图

添加“替换”支持

目前我们只能追加程序的输出。然而，如果有了“替换”，我们可以实现HTML转换器，例如https://github.com/ivanceras/svgbobrus。

这样，图表可以以文本形式编写，无论是在代码块中，还是在文件中，然后通过“include-file”包含。

termbook渲染插件程序为mdbook

将termbook中的所有渲染器作为独立的、与mdbook兼容的插件渲染器提供，以允许更轻松地与mdbook二进制文件集成。

取决于https://github.com/rust-lang-nursery/mdBook/issues/631

termbook预处理插件程序为mdbook

理想情况下，我们不需要将mdbook包装在termbook中。相反，应该为mdbook提供类似于已为渲染器所做的那样插件预处理支持。

维护指南

发布新版本

• 确保所有文档是最新的，并且测试是绿色的
• 运行cargo-clippy并修复所有问题
• 在所有Cargo.toml文件和git commit中更新version
• 运行cargo publish以发布库和CLI
• 运行 git tag -s <version>
• 运行 git push --tags origin master
• 更新 asciinema 文档
  • 将终端设置为合适的大小
  • 运行 make asciinema-no-upload
  • 当对结果满意时，运行 make asciinema-upload
  • 访问 URL，配置视频，使其公开，并将 markdown 链接复制到 README 文件中。
• 更新 brew 文件
  • 运行 make update-homebrew 并提交更改

每次将更改推送到 master 后，都会更新文档。