← 返回 Import API 列表

导入标准 Markdown

在 GitHub 上查看源码

POST /api/import/importStdMd

描述

从本地文件系统导入标准的 Markdown 文件(.md)或包含 Markdown 文件的文件夹到指定的笔记本和路径下。导入时会自动将 .md 文件转换为思源笔记的 .sy 格式。

请求参数

请求体需要是 JSON 格式。

参数名 类型 描述 必需
notebook string 目标笔记本的 ID。
localPath string 要导入的本地 Markdown 文件或文件夹的绝对路径。
toPath string 导入到目标笔记本内的路径(相对于笔记本根目录)。例如 /imported-markdown/

响应结果

响应体是 JSON 格式。code 为 0 表示成功。导入过程可能是异步的,API 成功返回仅代表开始处理。


{
  "code": 0,
  "msg": "",
  "data": null
}
    

如果请求处理或导入过程中出错(例如路径不存在、文件无读取权限、转换失败等),code 会是 -1,并包含错误信息。

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

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

在线测试

由于此 API 需要访问本地文件系统路径,存在权限和安全风险,不建议在此处直接测试。请通过思源笔记的导入功能或使用具有相应权限的脚本/工具进行操作。