Lib.rs

termbook 是一个命令行工具，在执行代码块的同时构建 mdbook 的，并将它们的输出收集到 mdbook 中。

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

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

安装

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

文档

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

路线图

添加 'replace' 支持

目前我们只能附加程序的输出。然而，如果有了 'replace'，我们可以实现 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 文件中的 version 以及 git commit
• 运行 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 并提交更改