# markdown-includes Table of contents - [markdown-includes](#markdown-includes) - [rustdoc](#rustdoc) - [Example](#example) --- A simple way of including other files, rust doc and table of content in a markdown file. For a repo's README file, you'll create a _README.tpl.md_ which you can edit like a normal markdown file, but with the added support for fenced includes which are TOML fences with an extra name containing the configuration of the include. ## rustdoc The rustdoc part of this crate is based on modified code from [cargo-rdme](https://crates.io/crates/cargo-rdme). The same limitations apply, especially for the syntax of [intralinks](https://github.com/orium/cargo-rdme#intralinks) ## Example _src/README.tpl.md_: > My title
>
> Include a table of content:
> ```toml toc
> header = "# Table of contents"
> ```
>
> Extracted from lib.rs' rust doc:
>
> ```toml rustdoc
> source = "lib.rs"
> ```
To generate a _README.md_ file you add a test: ```rust #[test] fn update_readme() { markdown_includes::update("src/README.tpl.md", "README.md").unwrap(); } ``` This test will update the README file if necessary, but if running in a CI pipeline (the CI environment variable is set), it will fail if the _README.md_ needs updating.