Extract code files from Markdown files.
Write guides in Markdown with code blocks that belong in several files, and let waltz extract the code for you so you can build/run/test it easily.
DANGER: Will eat your laundry
This is highly experimental. Has not been tested with real-world code.
There are pre-compiled binaries for newer releases that you can find on the releases page.
Alternatively, install it like this:
curl -LSfs https://japaric.github.io/trust/install.sh | sh -s -- --git killercup/waltz
Make sure you have Rust and Cargo installed.
$ cargo install --git https://github.com/killercup/waltz
Alternatively, clone this repository and run
cargo install --path waltz_cli.
Write regular Markdown, but add an additional file flag to your code blocks, so they have
lang,file=path after the triple back ticks. (This is the relative path of the file this code should end up in).
# Getting started First of all, create a simple `Cargo.toml` file: ```toml,file=Cargo.toml [package] authors = ["Pascal Hertleif <email@example.com>"] name = "foo" version = "0.1.0" ```
As Rust library
waltz = "0.4" to your dependencies and use it!
$ cargo install waltz_cli $ waltz [...] Usage: waltz <input file> [<target directory>] [...] $ waltz docs/guides/getting-started.md
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.