Markdown Publish & Share

🔗 curl 一键发布 Markdown 分享链接

通过 curl 命令将 Markdown 文档一键发布为可分享链接,支持 Mermaid 图表、KaTeX 公式与代码块渲染,适合开发者快速共享技术文档。

收藏
4k
安装
1.9k
版本
1.0.1
CLS 安全扫描中
预计需要 3 分钟...

使用说明

核心用法

AutEng Docs Curl Publish 是一个面向开发者的文档发布 API,允许用户通过简单的 curl 命令将 Markdown 内容转换为带渲染的在线分享链接。

主要功能特性:

  • 完整 Markdown 支持:包括标题、列表、表格、代码块等标准语法
  • Mermaid 图表渲染:原生支持组件图、流程图、时序图等技术图表
  • KaTeX 数学公式:支持行内和块级数学表达式渲染
  • 可选元数据配置:可设置文档标题和过期时间(默认 24 小时)

API 端点与参数:

POST https://auteng.ai/api/tools/docs/publish-markdown/
  • markdown(必填):原始 Markdown 内容字符串
  • title(可选):文档显示标题
  • expires_hours(可选):链接有效期,单位小时

响应格式:
成功调用后返回包含 share_url(公开分享链接)和 api_share_url(API 访问链接)的 JSON 对象。

显著优点

1. 极简集成:纯命令行操作,无需 SDK 或复杂配置,适合 CI/CD 流水线嵌入
2. 即时可用:单次 HTTP 请求即可完成发布,响应速度快

3. 丰富渲染能力:相比纯文本分享,支持的技术图表和公式渲染大幅提升技术文档可读性

4. 灵活过期控制:可按场景设置文档生命周期,平衡便利性与安全性

潜在缺点与局限性

1. 依赖外部服务:完全依赖 AutEng.ai 平台的可用性,存在单点故障风险
2. 链接有效期限制:默认或自定义的过期时间可能导致历史链接失效,需自行管理持久化需求

3. 无版本管理:单次发布即生成新链接,不支持文档迭代追踪

4. 内容隐私性:发布至第三方平台,敏感内容需谨慎评估

5. 网络可达性要求:使用场景需保证对 AutEng.ai 域名的网络访问权限

适合人群

  • 开发者和技术写作者需要快速分享技术文档、API 文档或架构图
  • DevOps 工程师希望在自动化流程中生成可读的构建报告或部署说明
  • 开源项目维护者需要临时托管贡献者指南或设计文档
  • 技术团队内部进行短周期协作,无需搭建自有文档平台

常规风险

  • 数据泄露风险:明文传输至第三方服务,含敏感信息(密钥、内网架构)的文档严禁使用
  • 服务连续性风险:免费/试用服务的稳定性与持续性无长期保障
  • 链接滥用风险:公开分享的 URL 可被任何人访问,需配合过期时间控制传播范围
  • 合规风险:企业用户需确认 AutEng.ai 的数据处理条款是否符合内部安全规范

Markdown Publish & Share 内容

手动下载zip · 1.5 kB
publish_clawhub.shtext/x-shellscript
请选择文件