思源笔记开发文档

Appearance

端点 ​

/api/export/exportMd

返回首页

Export Markdown ​

POST /api/export/exportMd

导出 Markdown。

请求参数 ​

json
{
  "id": "string", // 必填，文档/笔记本 id
  "pdf": false, // 可选，是否导出为 PDF
  "paragraphBeginningSpace": false, // 可选，段首是否空两格
  "keepFold": false, // 可选，保持块折叠
  "removeAssets": false // 可选，是否移除资源文件
}

返回数据 ​

如果导出成功，返回导出的路径。

json
{
    "code": 0,
    "msg": "",
    "data": {
        "path": "string" // 导出路径
    }
}

请求示例 ​

bash
curl -X POST \
  http://127.0.0.1:6806/api/export/exportMd \
  -H 'Authorization: Token YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "20200812220555-z0k8qkk",
    "pdf": false,
    "paragraphBeginningSpace": true,
    "keepFold": false,
    "removeAssets": false
  }'

响应示例 ​

json
{
  "code": 0,
  "msg": "",
  "data": {
    "path": "/path/to/exported/markdown/file.md"
  }
}

在线测试 ​

{"id": "", "pdf": false, "paragraphBeginningSpace": false, "keepFold": false, "removeAssets": false}
发送请求

导航 ​