← 返回 Export API 列表

导出预览 HTML

在 GitHub 上查看源码

POST /api/export/exportPreviewHTML

描述

将指定的文档块(ID)导出为带样式的预览 HTML 文件,并打包为 ZIP。HTML 文件会尽量模拟思源笔记编辑器的预览效果。

请求参数

请求体需要是 JSON 格式。

参数名 类型 描述 必需
id string 要导出的文档块 ID。
pdf boolean 是否为生成 PDF 进行优化(例如移除某些交互元素)。
keepFold boolean 是否在导出的 HTML 中保持块的折叠状态。

响应结果

响应体是 JSON 格式。code 为 0 表示成功。data 包含导出的 ZIP 文件信息。


{
  "code": 0,
  "msg": "",
  "data": {
    "path": "/temp/export/xxx.zip" // 导出的 ZIP 文件相对路径
  }
}
    

注意:这是一个社区维护的文档,可能与官方最新版本存在差异。

如果您觉得本文档有帮助,可以考虑赞助支持:爱发电

在线测试