华尔兹

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

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

危险：会吃掉你的衣服

这是一个高度实验性的项目。尚未与真实世界的代码进行测试。

安装二进制文件

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

或者，按如下方式安装

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 <[email protected]>"]
name = "foo"
version = "0.1.0"
```

作为 Rust 库

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

API 文档

命令行界面

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

许可协议

许可协议为以下之一

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

任选其一。

贡献

除非您明确声明，否则您提交的任何贡献，根据 Apache-2.0 许可证的定义，均应按上述方式双重许可，而无需任何额外的条款或条件。