8 个版本 (4 个重大变更)

0.5.1 2024 年 5 月 31 日
0.5.0 2024 年 5 月 14 日
0.4.0 2024 年 4 月 24 日
0.3.4 2024 年 4 月 23 日
0.1.0 2024 年 3 月 28 日

#6#asciidork

44 每月下载量
用于 3 个 crate (2 直接)

MIT 许可证

71KB
2K SLoC

🤓 Asciidork

使用 Rust 编写的 Asciidoc 解析器/后端

安装

# requires rust/cargo toolchain
cargo install asciidork-cli
或从源安装
git clone https://github.com/jaredh159/asciidork
cd asciidork
cargo build --release --bins

# vvvv -- OPTIONAL: or use rel path to `./target/release/asciidork` instead
sudo cp ./target/release/asciidork /usr/local/bin

使用方法

# read the friendly manual
asciidork --help

# parse/convert/print from a file
asciidork --input test.adoc

# without a --input arg, it reads from stdin
echo "foo _bar_ *baz*" | asciidork
asciidork < test.adoc

# don't include enclosing document structure by passing `--embedded`
asciidork --input test.adoc --embedded

# send output to a file (alternatively just redirect stdout)
asciidork --input test.adoc --embedded --output test.html

# print information about perf (did i mention it's written in Rust btw?)
asciidork --input test.adoc --print-timings

# print pretty html (requires `pretter` -- install w/ `npm i -g prettier`)
asciidork --input test.adoc --embedded --format dr-html-prettier

WASM

Asciidork 解析器和 dr-html 后端编译为 WASM 以在浏览器中运行!(我提到它是用 Rust 编写的吗?) 即将推出 NPM 包,但现在您可以在以下位置看到它的实际运行情况

https://asciidork-playground.vercel.app

请确保打开开发者工具以查看计时信息。

注意事项

[!WARNING] Asciidork 尚未完成。它实现了 Asciidoc 的多数文档行为,但有几个未完成区域,缺少错误处理,存在大量边缘情况!现在仅将其视为技术预览。

已知的 未完成或未实现 区域包括

  • CSV 表格
  • STEM
  • 源高亮显示
  • 包含指令
  • 所有实体引用

欢迎提交 PR! 👍

依赖项

~265–355KB