markdown-includes

目录

• markdown-includes
  • rustdoc
  • 示例

在markdown文件中包含其他文件、rust文档和目录的简单方法。

对于仓库的README文件，你会创建一个README.tpl.md，你可以像编辑普通的markdown文件一样编辑它，但增加了对围栏包含的支持，这些围栏包含包含配置的额外名称。

rustdoc

此crate的rustdoc部分基于来自cargo-rdme的修改后的代码。同样，对于内部链接的语法，存在相同的限制

示例

src/README.tpl.md:

我的标题

包含目录
```toml toc
header = "# 目录"
```

从lib.rs的rust文档中提取

```toml rustdoc
source = "lib.rs"
```

要生成README.md文件，请添加测试

#[test]
fn update_readme() {
    markdown_includes::update("src/README.tpl.md", "README.md").unwrap();
}

此测试将根据需要更新README文件，但如果在CI管道（CI环境变量已设置）中运行，如果需要更新README.md，则将失败。