Herdown

URL转Markdown开发者文档

查看URL解析、REST API、MCP、CLI和本地工具的使用说明。

网页解析接入

RESTAPI接收公开网页地址并返回结构化Markdown,适合服务端或自动化流程。

MCP和CLI

MCP适合支持工具调用的Agent,CLI适合终端脚本和本地批处理;两者都应使用文档中的认证方式。

浏览器插件

对于登录后、动态渲染或需要当前浏览器上下文的页面,插件可以在本地读取已打开页面。

输出和检查

接入方应检查解析状态、来源URL、正文、标题和限制信息,不要把空结果当成成功。

额度和安全

公开网页解析受免费额度和页面访问权限影响;不要提交密码、私人URL或无权处理的内容。

使用步骤

选择接入方式

根据调用场景选择RESTAPI、MCP、CLI或浏览器插件,并先确认对应的认证方式。

提交公开内容

API和自动化接入只提交有权处理的公开网页地址,浏览器插件适合当前浏览器上下文中的页面。

验证解析结果

检查状态、来源URL、标题、正文和限制字段,不要把空结果或错误响应当成成功。

工具FAQ

RESTAPI、MCP和CLI怎么选?

服务端集成使用RESTAPI,支持工具调用的Agent使用MCP,终端脚本和批处理使用CLI。

API会返回什么?

响应包含解析状态、来源信息和Markdown结果;接入方应按文档检查错误和限制字段。

可以提交私人URL吗?

不要提交密码、私人URL或无权处理的内容。需要登录后的页面时,应使用本地浏览器插件。