Skip to content

wiktor-k/tangler

Tangler

CI Crates.io

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.

About

Extracts (tangles) code fragments from Markdown documents.

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Security policy

Stars

Watchers

Forks

Sponsor this project

 

Packages

No packages published