Waltz

从Markdown文件中提取代码文件。

用Markdown编写带有属于多个文件的代码块的指南，然后让waltz为您提取代码，以便您轻松构建/运行/测试。

危险：会吃掉你的衣服

这是高度实验性的。尚未用真实世界的代码进行测试。

安装二进制文件

在新版本中，您可以在发布页面找到预编译的二进制文件。

或者，按照以下方式安装

curl -LSfs https://japaric.github.io/trust/install.sh | sh -s -- --git killercup/waltz

手动安装

请确保您已安装Rust和Cargo。

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

或者，克隆此仓库并运行cargo install --path waltz_cli。

用法

Markdown语法

编写常规Markdown，但为您的代码块添加一个额外的文件标志，以便它们在三个反引号之后有lang,file=path（这是代码应最终所在的文件的相对路径）。

示例

# 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"
```

作为Rust库

将waltz = "0.4"添加到您的依赖项中并使用它！

API文档

CLI

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

许可证

许可方式任选其一

• Apache License，版本2.0，(LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)
• MIT许可证 (LICENSE-MIT 或 https://open-source.org.cn/licenses/MIT)

任选。

贡献

除非您明确声明，否则任何有意提交以包含在您的工作中的贡献，如Apache-2.0许可证中定义，将按上述方式双重许可，不附加任何额外条款或条件。