Extract code files from Markdown
Rust
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
waltz
waltz_cli
.editorconfig
.gitignore
.travis.yml
Cargo.lock
Cargo.toml
LICENSE-APACHE
LICENSE-MIT
Readme.md
bors.toml

Readme.md

Waltz

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.

Install

Make sure you have Rust and Cargo installed.

$ cargo install --git https://github.com/killercup/waltz

Usage

Markdown syntax

Write regular Markdown, but add an addional file flag to your code blocks, so they have lang,file=path after the tripple back ticks. (This is the relative path of the file this code should end up in).

Example:

# Getting started

First of all, create a simple `Cargo.toml` file:

```toml,file=Cargo.toml
[package]
authors = ["Pascal Hertleif <killercup@gmail.com>"]
name = "foo"
version = "0.1.0"
```

As Rust library

Add waltz = "0.4" to your dependencies and use it!

API documentation

CLI

$ cargo install waltz_cli
$ waltz
[...]
Usage: waltz <input file> [<target directory>]
[...]
$ waltz docs/guides/getting-started.md

License

Licensed under either of

at your option.

Contribution

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.