3 个版本 (重大更改)

0.3.3 2024 年 4 月 17 日
0.2.0 2024 年 4 月 5 日
0.1.0 2024 年 3 月 28 日

图形 API 中排名第 299

每月下载量 35

MIT 许可证

3KB
81

🤓 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

请确保弹出开发工具以查看计时信息。

注意事项

[!警告] Asciidork 不完整。它实现了 Asciidoc 的大部分文档行为,但有几个未完成区域,缺少错误处理,有很多边缘情况!目前仅将其视为技术预览。

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

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

欢迎 PR! 👍

无运行时依赖