API 速查
Note
0.x 可能调整;集成请锁定版本。仓库与包名:penna-markdown。
包入口
| import | 主要符号 | IIFE 全局名 |
|---|---|---|
penna-markdown | Penna、PennaOptions、DEFAULT_TOOLBAR_ITEMS、Theme、EventBus、Log | PennaNextEditor |
penna-markdown/renderer | Renderer、RenderOption、Theme、EventBus、Log | PennaNextRenderer |
penna-markdown/transformer | TransformerEngine、BaseInlineParser 等 | PennaNextTransformer |
样式见 主题 与 package.json exports。
CDN(IIFE)
包已发布到 npm。jsDelivr 路径前缀:https://cdn.jsdelivr.net/npm/[email protected]/dist/(unpkg 把主机换成 unpkg.com 即可)。
| 文件 | 全局名 |
|---|---|
penna.min.js | PennaNextEditor(含 Penna、Theme、EventBus、Log …) |
penna-render.min.js | PennaNextRenderer(含 Renderer、Theme …) |
penna-transformer.min.js | PennaNextTransformer(含 TransformerEngine …) |
用法示例见 快速开始 · CDN。
Penna
import { Penna } from "penna-markdown";const penna = new Penna(rootEl, options);属性:theme、eventBus、storage(只读)。
方法:getMarkdown / setMarkdown / getLayout / setLayout / 侧栏显隐系列 / setSidebarActiveFile / runCommand / destroy。
完整字段见 编辑器。自定义解析走 preview.transformerEngineOptions。
Renderer
import { Renderer, Theme, EventBus, Log } from "penna-markdown/renderer";方法:render(增量优先)/ renderFull / append / getToc / getTocFlat / getMountedBlocks / getStore / getMount / destroy。
构造选项见 渲染器。
TransformerEngine
import { TransformerEngine } from "penna-markdown/transformer";方法:parse / parseIncremental / render / renderBlock。
构造选项见 转换器。
Theme
方法:list / setTheme / setLightDark / getTheme。详见 主题。
回调类型
(file: File) => Promise<{ url: string; msg: string }>editor.onParseFile:粘贴/拖入文件上传。
(action, text, prompts?, onUpdate?, signal?) => Promise<string>editor.onAiRequest:AI 生成;onUpdate 传增量 delta;signal 在用户取消时 abort。
本文已加密,请输入访问密码