返回工作台

HC.md REST API 文档

提供完整的 Markdown 渲染、解析、提取、校验与图片上传接口规范

MCP 协议文档
POST/api/markdown/render

将 Markdown 转换为带 Juice 内联 CSS 的 HTML,支持微信公众号与通用输出

请求参数 (JSON / Form)
{
  "content": "string (必填): Markdown 正文",
  "platform": "string: \"wechat\" | \"html\"",
  "markdownStyle": "string: \"kami\" | \"bauhaus\" | \"blueprint\" 等 8 种主题",
  "codeTheme": "string: \"kimbie-light\" | \"catppuccin-mocha\" 等 14 种主题",
  "customCss": "string: 追加的自定义 CSS (需在 #bm-md 下)"
}
响应示例 (200 OK)
{ "html": "...", "inlinedHtml": "...", "title": "..." }
POST/api/markdown/parse

将 HTML 转换为标准 Markdown 内容 (Turndown GFM)

请求参数 (JSON / Form)
{
  "html": "string (必填): 要转换的 HTML 内容"
}
响应示例 (200 OK)
{ "markdown": "# 转换后的 Markdown..." }
POST/api/markdown/extract

提取 Markdown 的纯文本,保留段落分隔

请求参数 (JSON / Form)
{
  "content": "string (必填): Markdown 正文"
}
响应示例 (200 OK)
{ "text": "纯文本内容..." }
POST/api/markdown/lint

使用 markdownlint 规则进行格式校验与自动修复

请求参数 (JSON / Form)
{
  "content": "string (必填): Markdown 正文",
  "fix": "boolean: 是否自动修复格式问题 (默认 true)"
}
响应示例 (200 OK)
{ "errors": [...], "content": "修复后的内容..." }
POST/api/upload/image

上传临时图片至图床,支持文件签名魔数校验 (PNG/JPEG/GIF/WebP)

请求参数 (JSON / Form)
{
  "file": "File (multipart/form-data, 限制 5MB)",
  "name": "string: 图片名称"
}
响应示例 (200 OK)
{ "url": "data:image/png;base64,...", "format": "png" }