新增共享 Preview Engine,统一 Web 连续预览、快速分页、Playwright PDF 与 Electron PDF;实现稳定前缀复用和修改位置后的增量分页,保留媒体块按文档顺序串行回填与单次重排。 完善跨端链接与桌面文档工作流:Web 受控处理锚点和 HTTP/HTTPS 外链;Desktop 支持本地路径、file URI、系统协议、多窗口、同文件单例、Markdown 当前或新窗口打开,以及聚焦时外部文件变化提示。 统一四套内置主题名称并默认使用 Typora Github;修复连续预览双滚动条、ECharts 尺寸、PDF 本地链接、围栏代码块 Typora DOM 与重复行内样式;桌面发行链强制完整重建内嵌 Web,避免安装包携带陈旧资源。 发布 Web/Compose 与 Windows NSIS/ZIP:镜像 yixiong/md-to-pdf:v0.5.0 已健康部署;NSIS SHA-256 为 60992D1FDCA513F46346C78478537EB4159D8C0E76B41ECF3CDC25BE77707D92,ZIP SHA-256 为 D74F82293FB67126E583546CBA894569EFC9A0B1B6343FAC648CCC95F1D188D8,本机安装版已升级至 v0.5.0。 验证:全项目 238 项测试通过,类型检查、生产构建和 git diff --check 通过;Web 快速/连续/精确预览、Compose、Desktop 多窗口、窗口状态、文件关联、链接与代码块均完成真实环境验收。
59 lines
1.6 KiB
Markdown
59 lines
1.6 KiB
Markdown
# @md-to-pdf/renderer
|
|
|
|
将 Markdown 转换为统一、安全的 `#write` HTML 文档。Web 预览、服务端
|
|
PDF 和桌面端 PDF 均通过应用服务复用本包,不维护第二套 Markdown 解析
|
|
逻辑。
|
|
|
|
## 目录结构
|
|
|
|
```text
|
|
src/
|
|
render-markdown.ts Front Matter、Markdown 扩展、安全过滤与元数据
|
|
index.ts 公共导出入口
|
|
tests/
|
|
render-markdown.test.ts
|
|
```
|
|
|
|
## 支持能力
|
|
|
|
- 标题锚点、表格、任务列表、脚注和代码高亮;
|
|
- markdown-it 原生围栏代码块及 Typora `.md-fences` DOM 兼容;
|
|
- KaTeX 数学公式;
|
|
- Mermaid 安全占位;
|
|
- `@md-to-pdf/markdown-echarts` ECharts YAML 围栏;
|
|
- 图片标题 DOM 与资源引用收集;
|
|
- 保留由 Web/Desktop 平台适配器处理的安全文档链接;
|
|
- `sanitize-html` 白名单过滤和统一 `<article id="write">` 输出。
|
|
|
|
## 使用
|
|
|
|
```ts
|
|
import { renderMarkdown } from "@md-to-pdf/renderer";
|
|
|
|
const result = renderMarkdown("# 示例", {
|
|
language: "zh-CN"
|
|
});
|
|
```
|
|
|
|
普通围栏代码块输出为:
|
|
|
|
```html
|
|
<pre class="md-fences" lang="ts"><code class="language-ts">...</code></pre>
|
|
```
|
|
|
|
`.md-fences` 让 Typora 主题负责完整代码块外观;共享预览引擎会移除内部
|
|
`code` 重复套用的行内代码盒模型,同时保留 highlight.js 的高亮 span。
|
|
Mermaid 和 ECharts 围栏继续使用各自的专用 DOM,不经过该分支。
|
|
|
|
实际应用优先通过 `@md-to-pdf/application` 调用,以便同时完成主题和图片
|
|
资源处理。
|
|
|
|
## 开发与验证
|
|
|
|
```powershell
|
|
npm run dev -w @md-to-pdf/renderer
|
|
npm run test -w @md-to-pdf/renderer
|
|
npm run typecheck -w @md-to-pdf/renderer
|
|
npm run build -w @md-to-pdf/renderer
|
|
```
|