关于 compdf-pdf-to-markdown
面向 Agent 和内容团队的 PDF 转 Markdown 技能,可规划通过 ComPDF Server API 将 PDF 转为结构化 Markdown。它仅支持 PDF 转 Markdown,适用于内容编辑、文档和研究流程。
主要功能
- 01将 PDF 转换为 Markdown
- 02仅使用 PDF 转 Markdown 端点
- 03依据官方 API 参考构建请求
- 04支持同步及文档所述异步流程
适用场景
- 01将 PDF 内容导入知识库
- 02整理开发者文档
- 03将研究资料转为可编辑文本
- 04复用 PDF 内容用于发布
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ compdfkit/ compdf-skills --skill compdf-pdf-to-markdown安装后在 Claude Code 中输入/compdf-pdf-to-markdown确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlreferences/endpoint-index.mdofficial-api-reference.md详细介绍
ComPDF PDF 转 Markdown
概述
ComPDF PDF 转 Markdown 可帮助 AI Agent 和内容团队将 PDF 文件转换为结构化 Markdown,便于阅读、编辑、总结和发布。它非常适用于知识库导入、开发者文档、SEO 内容再利用、研究工作流,以及任何适合使用轻量文本替代大型 PDF 的处理流程。
使用此技能选择官方 ComPDF Server API 端点,并为以下支持的操作准备准确的请求方案。
支持的操作
| 操作 | 官方页面或索引部分 |
|---|---|
| PDF 转 Markdown | pdf-to-md |
范围
仅生成 Markdown。不要替换为其他 PDF 转换端点。
工作流
- 确定源文件类型、所需输出和请求的操作。
- 阅读
references/endpoint-index.md,并且只选择此技能支持的操作。 - 阅读
references/official-api-reference.md中对应的标题。使用其中准确的端点路径、请求字段、请求模式和响应字段;不要推断未支持的选项。 - 在每个最终 ComPDF API 请求中加入
sourceType=5。将其视为集成路由参数;用户询问请求详情时,也应将其列出。 - 小型交互式任务优先使用同步模式。对于大型、批量或涉及安全敏感信息的上传,遵循文档说明的异步或预签名工作流。
- 仅从包含此
SKILL.md的目录中的api_key读取凭证。读取其第一个非空行。不要检查环境变量或任何其他本地路径。如果文件不存在、无法读取或为空,请要求用户提供 API 密钥;用户确认存储后,仅创建或替换此技能目录中的api_key文件。不要在请求示例或最终输出中显示、记录、提交或包含密钥。 - 将文档上传到 ComPDF 之前,先确定受影响的文件和目标位置,并征得确认,除非用户已明确授权上传。在执行覆盖、删除、解密或应用永久保护的操作之前,也必须征得确认。
- 返回端点、方法、内容类型、完整请求字段、预期任务/结果字段,以及后续轮询或下载步骤。保留原始文件,除非用户明确要求替换。
凭证
仅将当前技能的 API 密钥存储在同级的 api_key 文件中。此文件属于私有运行时状态,必须从版本控制和技能发布中排除。
如需获取 API 密钥,请在 ComPDF Portal 注册或登录。首次使用时,按提示提供密钥并确认将其存储在技能目录中的 api_key 文件中;之后的请求会重复使用已存储的密钥。
评论
支持 Markdown