release: 发布 v0.4.5

新增能力:Web 与 Desktop 支持新建和保存 Markdown;桌面端注册 .md/.markdown 打开程序,支持单实例文件转交、自定义主题目录以及窗口位置、尺寸和最大化状态的延迟原子持久化与屏幕越界修正。

界面与兼容性:保留打开 Markdown 为独立主操作,将新建、保存和主题目录收纳到更多菜单;Web 移除本地素材目录入口并明确默认不支持本地素材;新文档默认使用一级标题或首行合法化生成文件名,可不保存直接导出 PDF。

渲染修复:图片、Mermaid 和 ECharts 按文档顺序串行执行媒体分页回填,每个媒体元素至多重排一次;图片以限宽后的高度作为缩放基准,只缩放媒体主体并保持标题尺寸;ECharts 冻结为 SVG 图片后参与统一分页。

示例与文档:默认示例仅保留一张网络图片,增加有效 Base64 横图、竖图、边界图片及多尺寸 Mermaid/ECharts;更新根 README、Desktop README、部署文档、四个 packages README、PROGRESS 和 AGENTS 发布规范;登记 v0.4.6 超链接导航问题。

部署与验证:构建并运行 yixiong/md-to-pdf:v0.4.5 正式镜像,Compose 健康且 PDF 冒烟无 Mermaid/ECharts 错误;生成 NSIS 安装包和免安装 ZIP,本机已升级到 NSIS v0.4.5 并清理旧 Squirrel 安装;202 项测试、类型检查、生产构建和 git diff --check 全部通过。

发布产物:Setup.exe SHA-256 9CBD6362E15AA745185805E753D5A7749434E0E142E6CE0F66463E6A19468F1D;ZIP SHA-256 97B2D44E72F626A3396E5AB5B330FFB7F9BECAF945A1707808C876940A82E850;当前 Windows 产物未配置代码签名。
This commit is contained in:
SkyJourney
2026-07-28 13:31:42 +08:00
parent ac54ce46be
commit 925b0d1485
35 changed files with 3125 additions and 603 deletions
+46
View File
@@ -0,0 +1,46 @@
# @md-to-pdf/application
Web Server 与 Electron Desktop 共用的应用服务层,组合
`@md-to-pdf/core``@md-to-pdf/renderer`,统一处理 Markdown 渲染、
主题发现、主题资源和图片资源。Fastify 与 Electron IPC 只负责传输和
平台能力适配。
## 目录结构
```text
src/
application-service.ts 渲染、主题和资源用例入口
image-resources.ts 本地、Base64 与受限远程图片处理
theme-registry.ts 内置及自定义主题扫描、校验与缓存
index.ts 公共导出入口
tests/
application-service.test.ts
image-resources.test.ts
```
## 使用
```ts
import { createApplicationService } from "@md-to-pdf/application";
const service = createApplicationService({
bundledRoot,
localRoot
});
const themes = await service.listThemes();
const document = await service.render(request);
```
Web 端通过 `apps/server` 的 HTTP API 调用;桌面端在主进程中创建同一
服务,并通过受限 IPC 暴露给渲染进程。Web 默认不接收本地素材目录,
Desktop 才会以 Markdown 所在目录为边界解析相对资源。
## 开发与验证
```powershell
npm run dev -w @md-to-pdf/application
npm run test -w @md-to-pdf/application
npm run typecheck -w @md-to-pdf/application
npm run build -w @md-to-pdf/application
```
+47
View File
@@ -0,0 +1,47 @@
# @md-to-pdf/core
跨 Web、Server、Desktop 和渲染器共享的纯数据模型与校验规则。该包不
依赖浏览器、Electron 或 Fastify,负责保证各运行端使用同一份协议。
## 目录结构
```text
src/
document.ts Markdown 文档、分页载荷、结果与耗时模型
export-config.ts 纸张、边距、页眉页脚、页码与图表配置
theme.ts 主题清单、主题能力与 CSS 载荷模型
index.ts 公共导出入口
tests/
document.test.ts
export-config.test.ts
```
## 使用
```ts
import {
createPagedDocumentPayload,
defaultExportConfig,
exportConfigSchema
} from "@md-to-pdf/core";
const config = exportConfigSchema.parse(defaultExportConfig);
const payload = createPagedDocumentPayload({
document,
fileName: "example.md",
themeCss,
exportConfig: config
});
```
新增跨端字段时,应先在这里定义类型、默认值、Zod 校验和兼容迁移,再由
各适配层消费,避免 Web 与 Desktop 分别维护协议。
## 开发与验证
```powershell
npm run dev -w @md-to-pdf/core
npm run test -w @md-to-pdf/core
npm run typecheck -w @md-to-pdf/core
npm run build -w @md-to-pdf/core
```
+27
View File
@@ -6,6 +6,24 @@
该包不依赖 React、Paged.js 或特定 PDF 引擎。宿主可以将生成的
HTML 用于网页预览,也可以在图表完成渲染后交给 Chromium 输出 PDF。
## 目录结构
```text
src/
markdown-it-plugin.ts ECharts YAML 围栏与错误占位
parse-yaml.ts 受限 YAML 解析
protocol.ts 围栏协议与基础校验
security-policy.ts URL、函数、原型和规模安全策略
semantic-validator.ts 系列数据与坐标系语义校验
dom-contract.ts 宿主与浏览器运行时共用的 DOM 协议
browser.ts 浏览器入口
browser/ ECharts 按需加载、渲染和 SVG 冻结
index.ts Markdown 侧公共导出
styles/
echarts.css 图表、标题和错误占位样式
tests/ 解析、安全、语义、插件和真实 SVG 测试
```
## 基本语法
````markdown
@@ -289,6 +307,15 @@ Chromium `page.pdf()`。
3. 注册该系列的语义验证器;
4. 增加有效、缺少数据、错误数据结构和真实 SVG 渲染测试。
## 开发与验证
```powershell
npm run dev -w @md-to-pdf/markdown-echarts
npm run test -w @md-to-pdf/markdown-echarts
npm run typecheck -w @md-to-pdf/markdown-echarts
npm run build -w @md-to-pdf/markdown-echarts
```
参考:
- [ECharts 配置参考](https://echarts.apache.org/en/option.html)
+46
View File
@@ -0,0 +1,46 @@
# @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
```
## 支持能力
- 标题锚点、表格、任务列表、脚注和代码高亮;
- KaTeX 数学公式;
- Mermaid 安全占位;
- `@md-to-pdf/markdown-echarts` ECharts YAML 围栏;
- 图片标题 DOM 与资源引用收集;
- `sanitize-html` 白名单过滤和统一 `<article id="write">` 输出。
## 使用
```ts
import { renderMarkdown } from "@md-to-pdf/renderer";
const result = renderMarkdown("# 示例", {
language: "zh-CN"
});
```
实际应用优先通过 `@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
```