markdown-publish-share

📑 技术文档即时渲染分享专家

基于 AutEng API 的 Markdown 文档发布工具,支持 Mermaid 图表与 KaTeX 公式渲染,一键生成安全分享的临时链接。

收藏
15.7k
安装
3.3k
版本
v1.0.5
CLS 安全性认证2026-05-02
点击查看完整报告 >

使用说明

该 Skill 提供了一种通过命令行工具 curl 将 Markdown 文档发布至 AutEng 平台并获取可分享链接的解决方案。用户只需向指定 API 端点发送包含 markdown 内容的 POST 请求,即可获得渲染后的文档链接,支持在浏览器中直接查看包含 Mermaid 图表(如组件图、流程图、时序图)、KaTeX 数学公式及代码高亮的复杂技术文档。

核心用法上,该 Skill 本质是一份 API 使用指南,指导用户构造 curl 命令调用 https://auteng.ai/api/tools/docs/publish-markdown/ 接口。请求体需包含必填字段 markdown 文本,以及可选的 title(文档标题)和 expires_hours(链接有效期)。Skill 提供了多个示例,包括基础发布、提取分享链接、提取紧凑成功响应等,并明确提示将无 share_url 的响应视为错误。

显著优点在于其专业性和便利性。首先,它原生支持技术文档常用的 Mermaid 图表和 KaTeX 公式渲染,解决了普通 Markdown 分享平台对这类语法支持不足的问题。其次,生成的链接可设置过期时间(默认可能较短),适合临时分享敏感度不高的技术方案或会议资料。此外,纯 curl 命令的方式具有极高的兼容性,可在任何支持命令行的环境中使用,无需安装额外客户端。

潜在缺点和局限性主要包括对第三方服务的依赖。所有文档内容必须上传至 auteng.ai 服务器进行处理和托管,这意味着无法完全离线的本地渲染。链接的临时性虽然提供了一定的隐私保护,但也意味着长期存档需求无法满足。此外,作为 T3 来源的社区项目,其依赖的外部服务 AutEng 的长期可用性和数据保留政策存在不确定性。

适合的目标群体主要是技术写作者、软件架构师、开发团队以及教育工作者。特别适用于需要快速分享软件架构图、系统文档、数学物理推导过程或技术规范的场景。对于需要在 Slack、微信或邮件中即时分享可读性强的技术文档,但又不希望搭建复杂文档站点的团队尤为实用。

使用风险方面,首要关注的是数据隐私。由于文档内容需发送至第三方 API,包含公司机密、个人隐私或敏感商业信息的文档不应通过此渠道分享。其次是网络依赖性,如果 auteng.ai 服务不可用或网络受阻,将无法生成分享链接。此外,虽然 Skill 本身安全,但用户在使用 curl 命令时若不小心修改了示例代码,可能会导致意外的网络请求。建议用户始终审查要发送的 Markdown 内容,确保不包含密码、密钥等敏感信息,并合理设置链接过期时间以最小化信息暴露窗口。

安全解读

核心用法

markdown-publish-share 是一个纯文档型 Skill,通过调用 auteng.ai 的 API 端点,将 Markdown 内容发布为在线可分享的渲染页面。用户需使用 curl 发送 POST 请求至 https://auteng.ai/api/tools/docs/publish-markdown/,携带 markdown 内容(必需),可选配置 titleexpires_hours(默认过期时间)。Skill 提供完整的 curl 命令示例,包括如何提取 share_url 和精简的 JSON 响应。

显著优点

1. 丰富的渲染支持:原生支持 Mermaid 图表(组件图、流程图、序列图)、KaTeX 数学公式和语法高亮的代码块,满足技术文档、架构设计和数学推导的展示需求。
2. 零配置即用:无需注册或复杂认证,通过标准 curl 即可调用,适合自动化脚本和 CI/CD 流水线集成。

3. 快速共享:生成稳定的分享链接,便于团队协作、文档评审和外部传播。

4. 纯文档零风险:Skill 本身为 Markdown 说明文档,无可执行代码,无依赖注入风险。

潜在局限

  • 服务依赖:完全依赖 auteng.ai 第三方服务的可用性和持续性,无离线或自托管选项。
  • 隐私考量:用户 Markdown 内容需上传至 auteng.ai 服务器,敏感信息不适合通过此渠道发布。
  • 过期策略:链接默认有过期时间,长期存档需自行管理或续期。
  • 无高级协作功能:仅提供静态渲染页面,不支持实时协作编辑、评论或版本历史。

适合人群

  • 软件架构师、开发者:快速分享系统架构图、API 文档
  • 技术写作者:发布技术博客、教程、数学推导
  • 教育工作者:分享课件、讲义、公式推导过程
  • 需要临时公开 Markdown 文档但不想搭建博客的用户

常规风险

  • 数据泄露风险:虽然 auteng.ai 使用 HTTPS(TLS 1.2+),但用户仍应避免上传含敏感凭证、个人隐私或商业机密的文档。
  • 服务中断风险:auteng.ai 的 SLA 和长期运营稳定性未知,关键文档建议本地备份。
  • 链接失效:过期后链接无法访问,重要分享需提前规划保留策略。

markdown-publish-share 内容

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