快速开始
项目是什么
Penna Markdown 是浏览器端 Markdown 编辑 + 渲染 套件,拆成三个可独立引用的包入口:
| 入口 | 职责 |
|---|---|
penna-markdown | 完整编辑器(工具栏 / 侧栏 / 编辑区 / 预览) |
penna-markdown/renderer | Markdown 到 DOM(增量更新) |
penna-markdown/transformer | Markdown 到 AST 到 HTML 字符串 |
语法:GFM + Penna 扩展(Alert、容器、卡片、公式、Mermaid/ECharts 等)。
安装
pnpmnpmyarn
pnpm add penna-markdownnpm install penna-markdownyarn add penna-markdown开发本仓库:
pnpm installpnpm demopnpm buildpnpm test选哪条路
最小编辑器
页面里放一个挂载节点,例如 id 为
editor的容器,高度建议铺满视口。引入基础样式:
penna-editor-base.min.css与penna-render.min.css。非 default 皮肤再加对应的penna-theme-{id}-editor/render.min.css。初始化:
import { Penna } from "penna-markdown";const root = document.querySelector("#editor") as HTMLElement;const penna = new Penna(root, { themeId: "default", layout: "split", editor: { value: "# Hello\n\n**Penna Markdown**", },});
Tip
本地演示:pnpm demo,打开「全功能编辑器」可看到 Options / AI / 语法全集。
最小只读渲染
import { Renderer, Theme, EventBus, Log } from "penna-markdown/renderer";const mount = document.querySelector("#preview") as HTMLElement;const log = new Log(false);const eventBus = new EventBus(false, "[penna]", log);const theme = new Theme(eventBus, log, mount.parentElement!);new Renderer({ mount, theme, eventBus, logger: log }).render("# Hello");完整说明见 渲染器。
只要 AST / HTML
import { TransformerEngine } from "penna-markdown/transformer";const engine = new TransformerEngine();const ast = engine.parse("# Hello\n\n**world**");const html = engine.render(ast);本文已加密,请输入访问密码