Markdown

API 文档 | 变更日志 | 贡献

此仓库包含两个用于处理 Markdown 文档的项目

• markdown-ast — 一个将 Markdown 语法建模为 AST 的 Rust 包。

• ConnorGray/Markdown — 一个提供 Markdown 元素符号表示的 Wolfram paclet，以及 (待办) 用于打开和编辑 .md 文件的笔记本前端支持。

快速示例

在 Rust 中将 Markdown 文档解析为 AST

use markdown_ast::{markdown_to_ast, Block, Inline, Inlines};

let ast = markdown_to_ast("
Hello! This is a paragraph **with bold text**.
");

assert_eq!(ast, vec![
    Block::Paragraph(Inlines(vec![
        Inline::Text("Hello! This is a paragraph ".to_owned()),
        Inline::Strong(Inlines(vec![
            Inline::Text("with bold text".to_owned()),
        ])),
        Inline::Text(".".to_owned())
    ]))
]);

文件概览

• ./crates/markdown-ast: 通用 markdown-ast 包的源代码。

• ./paclets/Markdown/: ConnorGray/Markdown paclet 的源代码。

• ./crates/md2nb/: 命令行工具 md2nb 的源代码。

• ./crates/wolfram-markdown-link: Markdown paclet 使用的 LibraryLink 库的源代码。

• third-party/commonmark-spec/: commonmark-spec 仓库的 git 子模块。由 markdown-ast 一致性测试使用。

许可

根据以下任一项许可：

• Apache许可证，版本2.0（LICENSE-APACHE 或 http://www.apache.org/licenses/LICENSE-2.0）

• MIT许可证（LICENSE-MIT 或 http://opensource.org/licenses/MIT）

根据您的选择。

贡献

除非您明确声明，否则您有意提交的任何贡献，按照Apache-2.0许可证的定义，将按上述方式双重许可，不附加任何额外条款或条件。

开发者说明

有关在贡献此存储库时执行常见开发任务的说明，请参阅 Development.md。