literate-rs

一个允许在 Markdown 文件中编写代码的文献编程工具。

徽章

工作原理

在核心上，literate 从标准输入读取文件，并将代码块输出到标准输出作为一个单一的数据流。代码块可以通过各种质量过滤，例如语言、属性等。

真正的魔法

尽管 literate 本身非常简单，但真正的魔法发生在您将工具应用于整个目录时。例如，Rust 项目可以向他们的 build.rs 添加 literate，以便在构建时将示例编写为 Markdown。由于 Rust 有一个非常成熟的文档文化，实际的源代码可能不会从文献化的注释中受益太多。但是，可以设想一个工具，它可以将 Rust 的文档完全反转。源代码可以用 Markdown 文件定义，构建时可以将文本作为文档注释添加到代码块周围。用户可以插入不同的策略来遍历树以找到相关的文档。

测试

cat .\examples\tortuga.ta.md | literate --language tortuga --required