Markdown文档字符串解析器

这是一个 概念验证。

这个Rust库可以用来从格式如描述 这里 的文档中提取一些数据。

渲染 主分支的文档。

它做了什么

例如，给定一个字符串如下

Lorem ipsum

A longer description lorem ipsum dolor sit amet.

# Parameters

- `param1`: Foo
- `param2`: Bar

它将返回如下结构

DocBlock {
    teaser: "Lorem ipsum",
    description: Some("A longer description lorem ipsum dolor sit amet."),
    sections: [
        Parameters([
            ("param1", "Foo"),
            ("param2", "Bar")
        ])
    ]
}

许可证

许可协议为以下之一

• Apache许可证2.0版（LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0）
• MIT许可证（LICENSE-MIT 或 http://opensource.org/licenses/MIT）

任选其一。

贡献

除非您明确声明，否则任何有意提交以包含在作品中的贡献，根据Apache-2.0许可证定义，应双许可如上所述，不附加任何额外条款或条件。