3 个版本
0.0.3 | 2023 年 7 月 5 日 |
---|---|
0.0.2 | 2023 年 6 月 26 日 |
0.0.1 | 2023 年 6 月 26 日 |
#450 在 模板引擎 中
每月 21 次下载
14KB
277 行
DocDoc
简单工具,用于拼接基于文本的文件树。目前仅支持 Markdown。
为什么?我找不到一个易于使用和安装的工具来拼接我的 Markdown 文件。当然,这也很有趣!
安装
您需要 Rust 和 Cargo 来构建或安装此工具。您可以在 https://rustup.rs/ 找到 Rust 和 Cargo 的安装说明。
要安装最新版本,只需运行
cargo install docdoc
工作原理
创建一个条目文件。让我们称其为 entry.md
。它包含以下内容
# My paper
A paper about DocDoc.
#[docdoc:path="./intro.md"]
#[docdoc:path="./conclusion.md"]
您会注意到 #[docdoc:path="..."]
指令。这些指令告诉 DocDoc 哪里可以找到要包含的内容。DocDoc 将用路径中文件的 contents 替换指令,并递归地解析其包含的内容。
让我们添加一些其他文档。首先,intro.md
## Introduction
This is the introduction to my paper.
I like to keep things short.
然后是 conclusion.md
## Conclusion
So yeah, that was it. I had fun!
现在让我们让 DocDoc 将所有这些内容拼接在一起
docdoc -o output.md entry.md
完成!打开 output.md
读取整个文档的内容。
功能
- 从路径中包含文件
- 检测循环导入并报错
- 监视文件
- 从 Git 中包含
- [YOUR FEATURE HERE] 如果您缺少某个功能,请打开一个问题,我们将讨论它。
依赖项
~3–15MB
~133K SLoC