#markdown #export #annotations #split #file #chunks #md

bin+lib markdown_splitter

将 Markdown 文件根据注释分割成块的工具

1 个不稳定版本

0.1.1 2020年4月18日

#34 in #md

Apache-2.0

10KB
89

Markdown Splitter

根据注释将 Markdown 文件分割成块的实用工具

注释语法

为了标识文档的哪些部分应该被分割,我们可以使用 'export' 开放和关闭标签

# This is a document the is going to be splitted

<!-- export -->
This unnamed part will generate a new `export.md`
<!-- /export -->

This part will be ignored

<!-- export part1 -->
This contents will generate a new `part1.md`
<!-- /export part1 -->

<!-- export part-two.md -->
This contents will generate a new `part-two.md`
With multiple lines
<!-- /export -->

用法

mds markdown.md
tree
.
├── export.md
├── markdown.md
├── part1.md
└── part-two.md

选项

mds markdown.md
`export.md` created
`part1.md` created
`part-two.md` created

指定默认输出文件

mds markdown.md -o export.md
`export.md` created

用例

在单个文件中使用注释维护日记或博客。此工具允许将文件分割成多个 Markdown 文件,每个文章一个。这些 Markdown 文章现在可以使用 Gatsby 等静态网站生成器轻松发布。

构建

cargo build

测试

cargo test

待办事项

  • 支持每个文件多个导出标签。
  • 支持命名导出标签。
  • 更好的标签解析。

依赖项

~2.5MB
~49K SLoC