docs: 重新排版并大幅扩充了中英双语 README 文档
MoonMark 是一款完全使用 MoonBit 纯手工打造的、轻量级且极速的 Markdown 解析器与 HTML 渲染引擎。它致力于对齐 CommonMark 规范,为 MoonBit 开发者在构建静态博客系统(SSG)、在线文档预览工具、以及富文本编辑器后端时,提供坚实的基础设施支撑。
本项目采用典型的企业级开源架构设计:
moonmark/ ├── src/ast/ # 抽象语法树(AST)核心定义,定义了 Block 和 Inline 节点。 ├── src/parser/ # 状态机驱动的扫描器(Lexer)与向下递归解析器(Parser)。 ├── src/html/ # 安全转义工具及 HTML 渲染映射逻辑。 ├── src/cli/ # 提供开箱即用的命令行工具代码。 └── benches/ # 性能基准测试模块。
在您的 moon.pkg.json 中引入 MoonMark:
moon.pkg.json
{ "import": [ "zmjknn/moonmark/src/parser", "zmjknn/moonmark/src/html" ] }
pub fn main() { let markdown_text = "# 欢迎使用 MoonMark\n\n这是一个**纯 MoonBit** 编写的解析器!" // 1. 初始化解析器并生成 AST let p = @parser.Parser::new(markdown_text) let ast_document = p.parse() // 2. 渲染为安全 HTML let html_output = @html.Renderer::new().render(ast_document) println(html_output) }
我们非常欢迎任何形式的贡献!无论是提交 Bug 报告、完善文档,还是提交合并请求(Pull Request)。 在提交 PR 之前,请务必执行以下命令以保证代码规范与测试通过:
moon fmt moon test
本项目基于 Apache License 2.0 协议开源。
MoonMark 是一个使用 MoonBit 纯手工编写的轻量、高速且可扩展的 Markdown 到 HTML 转换工具。它致力于提供对 CommonMark 标准的良好支持,并为 MoonBit 开发者在构建博客系统、文档生成工具以及内容管理系统 (CMS) 时提供核心的基础依赖。
版权所有:中国计算机学会技术支持:开源发展技术委员会 京ICP备13000930号-9 京公网安备 11010802047560号
MoonMark - 高性能 MoonBit Markdown 解析与渲染引擎
MoonMark 是一款完全使用 MoonBit 纯手工打造的、轻量级且极速的 Markdown 解析器与 HTML 渲染引擎。它致力于对齐 CommonMark 规范,为 MoonBit 开发者在构建静态博客系统(SSG)、在线文档预览工具、以及富文本编辑器后端时,提供坚实的基础设施支撑。
🌟 核心特性
🏗️ 架构概览
本项目采用典型的企业级开源架构设计:
🚀 快速开始
1. 作为依赖引入
在您的
moon.pkg.json中引入 MoonMark:2. 基础使用示例
📜 进度与 Roadmap
🤝 参与贡献
我们非常欢迎任何形式的贡献!无论是提交 Bug 报告、完善文档,还是提交合并请求(Pull Request)。 在提交 PR 之前,请务必执行以下命令以保证代码规范与测试通过:
📄 许可证
本项目基于 Apache License 2.0 协议开源。