tangler
| Crates.io | tangler |
| lib.rs | tangler |
| version | 0.3.0 |
| source | src |
| created_at | 2023-01-16 10:56:44.364522 |
| updated_at | 2024-05-20 15:27:00.553311 |
| description | Extracts code blocks from Markdown documents |
| homepage | |
| repository | https://github.com/wiktor-k/tangler |
| max_upload_size | |
| id | 760087 |
| size | 61,284 |
David Runge (dvzrv)
documentation
README
Tangler
Extracts (tangles) code fragments from Markdown documents.
This can be used to test examples in README documents to make sure they are always up to date.
The most common use of this crate is installing it as part of the CI script, extracting selected code fragments and then executing them.
cargo install tangler
tangler bash < README.md | bash -euxo pipefail -
The first argument is a selector of the blocks that should be extracted. The tool takes the input markdown document from stdin and outputs only matching blocks to stdout.
License
This project is licensed under either of:
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.