comark

环境要求

• Node.js 运行环境（需能用 npm 安装包）
• npm 包管理器
• 项目中使用 TypeScript 或 JavaScript（示例为 TypeScript/ESM 写法）

安装与启动步骤

1. 1安装 comark

   在项目根目录安装 comark 依赖，作为解析库引入使用，无需单独启动服务。

   npm install comark

   复制

2. 2调用解析函数

   从 comark 导入 parseMarkdown，传入 Markdown 字符串，得到紧凑、可序列化的文档树。

   import { parseMarkdown } from 'comark'
   
   const tree = await parseMarkdown('# Hello **World**')
   console.log(tree)

   复制

3. 3选择并接入渲染器

   解析结果需交给渲染器输出，README 仅列出 React/Vue/Svelte/Angular/HTML/终端 ANSI，具体包名见官网文档。

如何确认成功

运行代码后打印出含 nodes、frontmatter、meta 的对象，且 h1 与 strong 节点结构正确即表示解析成功。

常见问题

注意事项

• README 未给出各渲染器的具体安装包名与用法，接入前请查阅官网 https://comark.dev 文档。
• 自定义组件语法为 ::alert{type="warning"} ... ::，属于可选扩展语法，不影响普通 Markdown。
• README 未说明最低 Node.js 版本，建议使用较新的 LTS 版本以避免 ESM/顶层 await 兼容问题。