Markdown Publish & Share

📄 一键发布 Markdown 为可分享链接

通过 curl 命令将 Markdown 文档发布为可分享链接,支持 Mermaid 图表、KaTeX 公式和代码块渲染。

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

使用说明

核心用法

AutEng Docs Curl Publish 是一个命令行工具技能,允许用户通过简单的 curl HTTP 请求将 Markdown 内容发布为在线可分享的渲染文档。

基本流程:
1. 向 https://auteng.ai/api/tools/docs/publish-markdown/ 发送 POST 请求

2. 请求体包含 markdown(必需)、title(可选)和 expires_hours(可选)字段

3. 服务器返回包含 share_url 的 JSON 响应

4. 使用 jq 工具提取分享链接或直接查看完整响应

支持的 Markdown 扩展功能:

  • Mermaid 图表:组件图、流程图、序列图等
  • KaTeX 数学公式:科学计算和技术文档渲染
  • 代码块:语法高亮显示

典型应用场景:

  • 快速分享技术文档或 API 说明
  • 发布包含图表的系统架构文档
  • 临时共享带有数学公式的学术论文片段
  • CI/CD 流水线中自动生成文档链接

显著优点

1. 零配置使用:无需安装任何软件,curl 和 jq 为标准 Unix 工具
2. 完整渲染支持:原生支持 Mermaid 和 KaTeX,解决 Markdown 生态中图表和公式渲染的痛点

3. 灵活过期控制:可设置文档有效期(小时级),适合临时分享场景

4. 命令行友好:完美集成到脚本和自动化工作流中

5. 即时可用:发布后立即可通过链接访问,无需额外构建步骤

潜在缺点与局限性

1. 平台依赖性:依赖 AutEng.ai 服务的可用性,存在单点故障风险
2. 网络要求:必须能够访问外部 API,无法离线使用

3. 隐私考量:敏感内容需上传至第三方服务器,尽管有过期机制

4. 功能边界:未明确说明文件大小限制、请求频率限制等配额政策

5. 长期可用性:分享链接的长期稳定性取决于服务商运营状况

适合人群

  • 开发者/DevOps 工程师:需要在 CI/CD 中生成文档链接
  • 技术写作者:快速分享带图表的技术草稿
  • 系统架构师:发布组件图和流程图进行团队评审
  • 开源贡献者:创建临时的 PR 说明文档
  • 教育工作者:分享带数学公式的教学材料

常规风险

| 风险类型 | 说明 | 缓解建议 |
|---------|------|---------|
| 数据泄露 | Markdown 内容传输至第三方服务器 | 避免包含密码、密钥等敏感信息;使用 `expires_hours` 限制暴露时间 |
| 服务中断 | API 不可用导致发布失败 | 实现错误处理逻辑,检查 `share_url` 是否存在 |
| 链接失效 | 过期后文档不可访问 | 重要文档应本地备份或选择其他持久化方案 |
| 注入风险 | 若 Markdown 包含用户输入需警惕 XSS | 对动态内容做适当转义,依赖服务端的渲染安全机制 |

使用建议

始终将 share_url 的缺失视为错误状态,并输出完整响应以便调试。建议在生产脚本中设置超时和重试机制。

Markdown Publish & Share 内容

手动下载zip · 1011 B
SKILL.mdtext/markdown
请选择文件