#markdown #generator #generate-markdown #md #library #readme #documentation

morc

极简,使用 Rust 编写的最小化 Markdown 生成库

2 个版本

0.0.2 2023 年 10 月 22 日
0.0.1 2023 年 10 月 22 日

#1409文本处理

MIT 许可证

195KB
82

morc

Build Status License Docs Latest Version rustc 1.31+

极简,使用 Rust 编写的最小化 Markdown 生成库。 Morc 处于 https://github.com/refcell/morc/labels/beta

安装 | 用户文档 | Crates Docs | 参考 | 贡献 | 许可证 | 归属

什么是 morc?

morc 是一个极简的、用于生成有效 Markdown 文件的库。它最初是为 amble 构建的,但后来被提取出来成为一个独立的 crate,以提供一个可扩展的库,发布在 crates.io 上。

用法

使用 cargo 将 morc 添加为依赖项。

cargo add morc

以下是一个使用 morc 生成 Markdown 的简短示例。

use morc::core::{Document, Header, Section, Validate};

fn main() {
    let doc = Document {
        sections: vec![Box::new(Section {
            header: Some(Header::new(1, "Hello".to_string())),
            body: None,
            subsections: vec![],
        })],
    };
    assert!(doc.validate());
}

贡献

所有贡献都受欢迎!鼓励实验,并欢迎提出新问题。

故障排除 & 错误报告

请检查现有问题以查找类似错误,如果尚未存在相关问题,请 提出问题

归属

Morc 是从第一性原理构建的,从头开始设计,最小化外部参考。它是设计的一个沙盒实验。

许可证

本项目根据 MIT 许可证 许可。免费和开源,永远。 我们的所有 Rust 都属于你。

依赖关系

~0.8–1.8MB
~38K SLoC