MDEx 使用教程

MDEx 使用教程

mdex A fast 100% CommonMark-compatible GitHub Flavored Markdown parser and formatter for Elixir. 项目地址: https://gitcode.com/gh_mirrors/md/mdex

1. 项目介绍

MDEx 是一个为 Elixir 语言编写的快速且可扩展的 Markdown 解析器，它遵循 CommonMark 规范，可以将 Markdown 格式转换为 HTML、JSON 和 XML 等格式。MDEx 基于 comrak、ammonia 和 autumnus 这三个库构建，提供了语法高亮、HTML 清理、emoji 短码等功能，同时也支持 GitHub Flavored Markdown (GFM)。

2. 项目快速启动

首先，您需要在 Elixir 项目中添加 MDEx 作为依赖：

def deps do
  [
    {:mdex, "~> 0.5"}
  ]
end

然后，运行 mix 命令安装依赖：

mix install

以下是一个简单的例子，展示如何将 Markdown 文本转换为 HTML：

iex> MDEx.to_html!("# Hello")
"<h1>Hello</h1>"

3. 应用案例和最佳实践

语法高亮

MDEx 支持 Markdown 中的代码块语法高亮。以下是如何在 Markdown 中启用语法高亮的例子：

```elixir
defmodule Hello do
  def world do
    "Hello, World!"
  end
end

### 表格渲染

MDEx 支持渲染 Markdown 表格。以下是一个例子：

```markdown
| 特性 | 状态 |
| ---- | ---- |
| 快速 | √ |
| GFM | √ |

任务列表

您可以使用 MDEx 创建任务列表：

- [x] 任务 A
- [x] 任务 B
- [ ] 任务 C

4. 典型生态项目

• mdex_mermaid: 一个渲染 Mermaid 图表的项目，可以与 MDEx 集成。

以上就是 MDEx 的基本使用教程。您可以根据具体需求进一步探索和定制 MDEx 的功能。

mdex A fast 100% CommonMark-compatible GitHub Flavored Markdown parser and formatter for Elixir. 项目地址: https://gitcode.com/gh_mirrors/md/mdex