#sync #parse #file #markdown #parse-markdown #setup #code-document

bin+lib 写作

写作,是一个简单的代码文档同步工具

4 个版本

0.2.1 2021 年 10 月 22 日
0.2.0 2021 年 10 月 22 日
0.1.1 2021 年 10 月 21 日
0.1.0 2021 年 9 月 18 日

#17 in #parse-markdown

MIT 许可证

20KB
506

写作

是设置用的文档-代码同步工具。

过程

  1. 读取 Markdown 文件
  2. 解析 Markdown 代码
  3. 插入新代码
  4. 生成新代码

DSL 设计

按行

// doc-code: file("src/lib.rs").line()[1, 5]

按节(待定)

// doc-section: file("src/lib.rs").section("section1")

按功能(待定)

// doc-func: file("src/lib.rs").func()["pre_process_file", "process_file"]

文档

API 库的文档体系支持:主流编程语言的文档设计

文档工程体验设计:重塑开发者体验

许可证

@ 2021 本代码根据 MIT 许可证分发。请参阅此目录中的 LICENSE

依赖

~19–28MB
~584K SLoC