budshome (blog: 芽之家) shared the aphorism --
失败只有一个原因,把做产品看作实现自己梦想的方式。但产品本质是帮他人解决问题,别人需要什么你就要做什么,而不是我只做我喜欢的。你的产品做到了你心中的最好,被你视若珍宝,但对别人没有任何特殊之处。 -- 佚名

[Rust] Rust 中将 markdown 渲染为 html

💥 内容涉及著作权,均归属作者本人。若非作者注明,默认欢迎转载:请注明出处,及相关链接。

Summary: Rust 中,对于将 markdown 渲染为 html 方面,目前成熟度较高的 crate 主要有 2 个:`markdown.rs` 和 `pulldown-cmark`。功能都非常完善和强大:支持解析文档注脚(footnote)、github 风格的表格、github 风格的任务列表,以及删除线效果(strikethrough)等,但要主要支持是选择性地。 性能方面,或许测试体量不足,笔者测试感觉差别不大。前者 `markdown.rs` 稍微简单易用一些。后者 `pulldown-cmark` 专注于 `CommonMark`,默认提供命令行工具。采用拉取解析(pull parse)模式,其为 Rust 开发的书籍工具 `mdBook` 所使用。

Topics: rust markdown html

轻量级标记语言 markdown 现今不仅在程序员范围内流行,很多的其它行业人员也对 markdown 青睐有加。因此现在的 web 应用中,富文本编辑器越来越多的支持 markdown 语法格式,以及即时渲染功能。在存储时,数据库中存入轻量级标记语言 markdown 文档,方便后续导出再做它用的排版。也可以直接数据库中存入渲染后的 html 文档,对 API 调用者提供方便(如格式和验证等)。

Rust 中,对于将 markdown 渲染为 html 方面,目前成熟度较高的 crate 主要有 2 个:markdown.rspulldown-cmark。功能都非常完善和强大:支持解析文档注脚(footnote)、github 风格的表格、github 风格的任务列表,以及删除线效果(strikethrough)等,但要主要支持是选择性地。

性能方面,或许测试体量不足,笔者测试感觉差别不大。前者 markdown.rs 稍微简单易用一些。后者 pulldown-cmark 专注于 CommonMark,默认提供命令行工具。采用拉取解析(pull parse)模式,其为 Rust 开发的书籍工具 mdBook 所使用。

我们下面通过实例体验一下,这些代码都是完整可用于生产环境的。

markdown.rs

markdown.rs 使用非常简单:

use markdown;

// 如果您没有异步库 async-std 依赖项,
// 请替换下述前 2 行代码为
// fn main() {
#[async_std::main]
async fn main() {
    let html: String = markdown::to_html("__我是 *markdown*__");

    assert_eq!(&html, "<p><strong>我是 <em>markdown</em></strong></p>\n")
}

也可以通过读入 markdown 文件来解析。如我们有一个 markdown 文档 code.md

    # Rust 代码

    这是 Tide 中对 **cookie** 进行增、删的例子。

    ``` Rust
    use tide::http::Cookie;
    use tide::{Request, Response, StatusCode};

    /// Tide will use the the `Cookies`'s `Extract` implementation to build this parameter.

    async fn insert_cookie(_req: Request<()>) -> tide::Result {
        let mut res = Response::new(StatusCode::Ok);
        res.insert_cookie(Cookie::new("hello", "world"));
        Ok(res)
    }

    async fn remove_cookie(_req: Request<()>) -> tide::Result {
        let mut res = Response::new(StatusCode::Ok);
        res.remove_cookie(Cookie::named("hello"));
        Ok(res)
    }
    ```

我们通过 Rust 标准库的文件模块读入 code.md 并将其转换为 html。

use markdown;
use std::path::Path;

// 如果您没有异步库 async-std 依赖项,
// 请替换下述前 2 行代码为
// fn main() {
#[async_std::main]
async fn main() {
    let md = Path::new("./code.md");
    let html = markdown::file_to_html(md);

    println!("{:#?}", &html);
}

输出的 html 为:

<h1>Rust 代码</h1>
<p>这是 Tide 中对 <strong>cookie</strong> 进行增、删的例子。</p>
<pre><code class="language-Rust">use tide::http::Cookie;
use tide::{Request, Response, StatusCode};

/// Tide will use the the `Cookies`'s `Extract` implementation to build this parameter.

async fn insert_cookie(_req: Request&lt;()&gt;) -&gt; tide::Result {
    let mut res = Response::new(StatusCode::Ok);
    res.insert_cookie(Cookie::new(&quot;hello&quot;, &quot;world&quot;));
    Ok(res)
}

async fn remove_cookie(_req: Request&lt;()&gt;) -&gt; tide::Result {
    let mut res = Response::new(StatusCode::Ok);
    res.remove_cookie(Cookie::named(&quot;hello&quot;));
    Ok(res)
}
</code></pre>

若我们在其顶部引入 highlight.js 代码高亮库和 night-owl.css 样式,即可达到生产环境使用的效果。

markdown.rs 渲染

当然,也可以通过 markdown.rs 渲染 markdown 文档为 html 后,直接通过 file 模块将其存为文件。

pulldown-cmark

pulldown-cmark 是为 CommonMark 实现的拉取模式的解析器,通过事件迭代来驱动推送。笔者在生产环境中主要以 pulldown-cmark 来进行 markdown 文档到 html 的渲染。pulldown-cmark 的代码稍微复杂一些,但特性也更丰富一些。

比如删除线(strikethrough)效果并非 CommonMark 标准的一部分,而是 github 风格的 markdown 语法,因此我们必须明确地启用它。

use pulldown_cmark::{Parser, Options, html};

let markdown_input = "各位,请查看~~删除线~~*效果*的示例。";

// 设定解析器选项,包括 5 个等级,
// `ENABLE_STRIKETHROUGH` 为第三等级,包括删除线效果。
let mut options = Options::empty();
options.insert(Options::ENABLE_STRIKETHROUGH);
let parser = Parser::new_ext(markdown_input, options);

// 写入字符串缓冲区
let mut html_output = String::new();
html::push_html(&mut html_output, parser);

// 检查输出是否符合预期
let expected_html = "<p>各位,请查看<del>删除线</del><em>效果</em>的示例。</p>\n";
assert_eq!(expected_html, &html_output);

文章的开始提到,pulldown-cmark 默认提供命令行工具。因此,对于 markdown 文件的读入解析和渲染,一种是通过命令行。在服务器端代码中,还可以直接将文件读入到字符串,然后进行解析渲染为 html。

本文主要介绍 markdown 渲染为 html,对于 html 渲染为 markdown,也是同样简单的,都是如同 markdown.rs 的实现方法,一行代码即可。

谢谢您的阅读。


Rust 生态与实践

Related Articles

  1. [Rust] Rust 1.56.0 版本和 Rust 2021 版次发布,新特性一览,及项目的迁移、升级
  2. [WebAssembly] Rust 和 Wasm 的融合,使用 yew 构建 WebAssembly 博客应用的体验报告
  3. [Rust] Rust 官方周报 399 期(2021-07-14)
  4. [WebAssembly] Rust 和 Wasm 的融合,使用 yew 构建 web 前端(5)- 构建 HTTP 请求、与外部服务器通信的两种方法
  5. [Rust] Rust 官方周报 398 期(2021-07-07)
  6. [Rust] Rust 官方周报 397 期(2021-06-30)
  7. [Rust] Rust 官方周报 396 期(2021-06-23)
  8. [Rust] Rust 官方周报 395 期(2021-06-16)
  9. [Rust] Rust 1.53.0 明日发布,关键新特性一瞥
  10. [Rust] 使用 tide、handlebars、rhai、graphql 开发 Rust web 前端(3)- rhai 脚本、静态/资源文件、环境变量等
  11. [Rust] 使用 tide、handlebars、rhai、graphql 开发 Rust web 前端(2)- 获取并解析 GraphQL 数据
  12. [Rust] 使用 tide、handlebars、rhai、graphql 开发 Rust web 前端(1)- crate 选择及环境搭建
  13. [Rust] Rust 官方周报 394 期(2021-06-09)
  14. [Rust] Rust web 前端库/框架评测,以及和 js 前端库/框架的比较
  15. [WebAssembly] Rust 和 Wasm 的融合,使用 yew 构建 web 前端(4)- 获取 GraphQL 数据并解析
  16. [WebAssembly] Rust 和 Wasm 的融合,使用 yew 构建 web 前端(3)- 资源文件及小重构
  17. [WebAssembly] Rust 和 Wasm 的融合,使用 yew 构建 WebAssembly 标准的 web 前端(2)- 组件和路由
  18. [WebAssembly] Rust 和 Wasm 的融合,使用 yew 构建 WebAssembly 标准的 web 前端(1)- 起步及 crate 选择
  19. [Rust] Rust 官方周报 393 期(2021-06-02)
  20. [Rust] Rust 官方周报 392 期(2021-05-26)
  21. [Rust] Rust 中,对网址进行异步快照,并添加水印效果的实践
  22. [Rust] Rust 官方周报 391 期(2021-05-19)
  23. [Rust] Rust,风雨六载,砥砺奋进
  24. [Rust] 为什么我们应当将 Rust 用于嵌入式开发?
  25. [Rust] Rust 官方周报 390 期(2021-05-12)
  26. [Rust] Rust + Android 的集成开发设计
  27. [Rust] Rust 1.52.1 已正式发布,及其新特性详述
  28. [Rust] 让我们用 Rust 重写那些伟大的软件吧
  29. [Rust] Rust 1.52.0 已正式发布,及其新特性详述
  30. [Rust] Rust 官方周报 389 期(2021-05-05)
  31. [GraphQL] 基于 actix-web + async-graphql + rbatis + postgresql / mysql 构建异步 Rust GraphQL 服务(4) - 变更服务,以及小重构
  32. [Rust] Rust 1.52.0 稳定版预发布测试中,关键新特性一瞥
  33. [Rust] Rust 生态中,最不知名的贡献者和轶事
  34. [Rust] Rust 基金会迎来新的白金会员:Facebook
  35. [Rust] Rustup 1.24.1 已官宣发布,及其新特性详述
  36. [Rust] Rust 官方周报 388 期(2021-04-28)
  37. [Rust] Rust 官方周报 387 期(2021-04-21)
  38. [GraphQL] 构建 Rust 异步 GraphQL 服务:基于 tide + async-graphql + mongodb(4)- 变更服务,以及第二次重构
  39. [Rust] Rustup 1.24.0 已官宣发布,及其新特性详述
  40. [Rust] basedrop:Rust 生态中,适用于实时音频的垃圾收集器
  41. [Rust] Rust 编译器团队对成员 Aaron Hill 的祝贺
  42. [Rust] Jacob Hoffman-Andrews 加入 Rustdoc 团队
  43. [机器人] 为什么应将 Rust 引入机器人平台?以及机器人平台的 Rust 资源推荐
  44. [Rust] rust-lang.org、crates.io,以及 docs.rs 的管理,已由 Mozilla 转移到 Rust 基金会
  45. [Rust] Rust 官方周报 386 期(2021-04-14)
  46. [Rust] Rust 编译器(Compiler)团队 4 月份计划 - Rust Compiler April Steering Cycle
  47. [GraphQL] 基于 actix-web + async-graphql + rbatis + postgresql / mysql 构建异步 Rust GraphQL 服务(3) - 重构
  48. [Rust] 头脑风暴进行中:Async Rust 的未来熠熠生辉
  49. [GraphQL] 基于 actix-web + async-graphql + rbatis + postgresql / mysql 构建异步 Rust GraphQL 服务(2) - 查询服务
  50. [GraphQL] 基于 actix-web + async-graphql + rbatis + postgresql / mysql 构建异步 Rust GraphQL 服务 - 起步及 crate 选择
  51. [Rust] Rust 2021 版本特性预览,以及工作计划
  52. [Rust] Rust 用在生产环境的 42 家公司
  53. [Rust] 构建最精简的 Rust Docker 镜像
  54. [Rust] Rust 官方周报 385 期(2021-04-07)
  55. [Rust] 使用 Rust 做异步数据采集的实践
  56. [Rust] Android 支持 Rust 编程语言,以避免内存缺陷
  57. [Rust] Android 平台基础支持转向 Rust
  58. [Rust] Android 团队宣布 Android 开源项目(AOSP),已支持 Rust 语言来开发 Android 系统本身
  59. [Rust] RustyHermit——基于 Rust 实现的下一代容器 Unikernel
  60. [Rust] Rustic:完善的纯粹 Rust 技术栈实现的国际象棋引擎,多平台支持(甚至包括嵌入式设备树莓派 Raspberry Pi、Buster)
  61. [Rust] Rust 迭代器(Iterator trait )的要诀和技巧
  62. [Rust] 使用 Rust 极致提升 Python 性能:图表和绘图提升 24 倍,数据计算提升 10 倍
  63. [Rust] 【2021-04-03】Rust 核心团队人员变动
  64. [Rust] Rust web 框架现状【2021 年 1 季度】
  65. [Rust] Rust 官方周报 384 期(2021-03-31)
  66. [Rust] Rust 中的解析器组合因子(parser combinators)
  67. [生活] 毕马威(KPMG)调查报告:人工智能的实际采用,在新冠疫情(COVID-19)期间大幅提升
  68. [Python] HPy - 为 Python 扩展提供更优秀的 C API
  69. [Rust] 2021 年,学习 Rust 的网络资源推荐(2)
  70. [Rust] 2021 年,学习 Rust 的网络资源推荐
  71. [生活] 况属高风晚,山山黄叶飞——彭州葛仙山露营随笔
  72. [Rust] Rust 1.51.0 已正式发布,及其新特性详述
  73. [Rust] 为 Async Rust 构建共享的愿景文档—— Rust 社区的讲“故事”,可获奖
  74. [Rust] Rust 纪元第 382 周最佳 crate:ibig 的实践,以及和 num crate 的比较
  75. [Rust] Rust 1.51.0 稳定版本改进介绍
  76. [Rust] Rust 中将 markdown 渲染为 html
  77. [生活] 国民应用 App 的用户隐私数据窥探
  78. [GraphQL] 构建 Rust 异步 GraphQL 服务:基于 tide + async-graphql + mongodb(3)- 重构
  79. [GraphQL] 构建 Rust 异步 GraphQL 服务:基于 tide + async-graphql + mongodb(2)- 查询服务
  80. [GraphQL] 构建 Rust 异步 GraphQL 服务:基于 tide + async-graphql + mongodb(1)- 起步及 crate 选择
  81. [Rust] Rust 操控大疆可编程 tello 无人机

Topics

rust(81)

graphql(17)

rust-官方周报(17)

webassembly(15)

async-graphql(9)

wasm(9)

rust-官方博客(8)

yew(8)

tide(7)

rust-web(7)

this-week-in-rust(6)

mysql(5)

rbatis(5)

android(4)

actix-web(4)

mongodb(3)

json-web-token(3)

jwt(3)

cargo(3)

技术延伸(3)

rust-wasm(3)

trunk(3)

handlebars(3)

rhai(3)

用户隐私(2)

学习资料(2)

python(2)

ai(2)

人工智能(2)

postgresql(2)

rust-compiler(2)

rust-基金会(2)

rust-foundation(2)

rustup(2)

rust-toolchain(2)

rust-工具链(2)

rust-游戏开发(2)

rust-区块链(2)

rust-2021(2)

graphql-client(2)

rust-game(2)

tello(1)

drone(1)

无人机(1)

隐私数据(1)

markdown(1)

html(1)

crate(1)

async(1)

异步(1)

旅游(1)

不忘生活(1)

葛仙山(1)

hpy(1)

python-扩展(1)

正则表达式(1)

解析器组合因子(1)

组合器(1)

regular-expression(1)

parser-combinator(1)

regex(1)

官方更新(1)

rust-工作招聘(1)

rust-技术资料(1)

rust-周最佳-crate(1)

rust-web-框架(1)

rust-web-framework(1)

rust-核心团队(1)

rust-core-team(1)

rust-language-team(1)

pyo3(1)

rust-python-集成(1)

python-性能改进(1)

迭代器(1)

iterator-trait(1)

国际象棋(1)

chess(1)

游戏引擎(1)

game-engine(1)

虚拟化(1)

unikernel(1)

rustyhermit(1)

linux(1)

virtualization(1)

sandboxing(1)

沙箱技术(1)

数据采集(1)

异步数据采集(1)

docker(1)

镜像(1)

生产环境(1)

rust-评价(1)

rust-2021-edition(1)

rust-2021-版本(1)

graphql-查询(1)

vision-doc(1)

愿景文档(1)

代码重构(1)

steering-cycle(1)

方向周期(1)

隐私声明(1)

机器人(1)

robotics(1)

rustdoc(1)

rust-编译器(1)

实时音频(1)

real-time-audio(1)

变更服务(1)

mutation(1)

查询服务(1)

query(1)

rust-贡献者(1)

rust-轶事(1)

rust-稳定版(1)

rust-预发布(1)

rust-测试(1)

安全编程(1)

可信计算(1)

安全代码(1)

secure-code(1)

rust-android-integrate(1)

rust-embedded(1)

rust-嵌入式(1)

rust-生产环境(1)

rust-production(1)

网页快照(1)

网页截图(1)

水印效果(1)

图片水印(1)

yew-router(1)

css(1)

web-前端(1)

wasm-bindgen(1)

区块链(1)

blockchain(1)

surf(1)

dotenv(1)

标识符(1)

rust-1.53.0(1)

rusthub(1)

rust-1.56.0(1)

rust-项目升级(1)

Elsewhere

- Open Source
  1. github/zzy
  2. github/sansx
- Learning & Studying
  1. Rust 学习资料 - 芽之家