这个项目能做什么
Folio 被定义为一种 Markdown 格式和一套工具,用于在解释程序的文档内部编写程序。文档可以以包含 format、id、type、status 和 tangle root 等字段的 YAML 标头开始。代码块可以命名并指定目标文件。Tangling 将文档的代码块收集到源文件中,在每个文件的注释样式中写入生成的标头,并记录一个显示哪个块产生了哪个文件的 tangle-map 边车文件。块可以通过在行中放置块引用来进行拼接,将该块粘贴在引用的缩进处。Weaving 将同一文档渲染为阅读页面。Checker 根据提供的词汇表或文档中定义的词汇表验证文档元数据。提供的词汇表描述了文档、软件及其关系,并且可以扩展或替换。文档可以使用 Turtle 或 YAML 块声明概念和实例。Publications 从较大的集合中选择文档和代码,并生成一个独立仓库,其来源记录在 PROVENANCE.json 中,且拒绝依赖于选择范围之外的 crates。本仓库就是这样生成的,包括该工具以及生成它的源文档。生成的 Rust 代码已提交,因此可以通过 cargo 构建新鲜的克隆版本。指南涵盖了集成、将文档指向现有代码以及当前的局限性。CI 可以重新进行 tangle,并在树结构发生变化时报错。许可证为 MIT,依赖项许可证保留其自身条款。README 还提供了一个示例提示词,用于要求智能体评估 Folio 在项目中的帮助作用。
评论
0 评分人数达到10人后显示
登录后参与讨论。