核心用法
MD Web 是一个将 Markdown 文件渲染为美观网页的实用工具。用户通过 Node.js 脚本 upload.js 将 .md 文件上传至自有的 S3 兼容存储桶(Cloudflare R2、AWS S3 等),由预部署的 Docsify 服务器自动渲染为网页,返回可分享的公开 URL。
操作流程:
1. 配置检查:确认 ~/.md-web/config.json 存在,否则引导用户配置 S3 凭证
2. 准备文件:使用现有 .md 文件或写入临时文件
3. 执行上传:node {SKILL_DIR}/upload.js <local-file> <remote-key>,脚本自动检测并部署 Docsify 服务端文件
4. 返回结果:成功时仅返回文件名和可点击链接;失败则回退为直接发送 Markdown 文本
显著优点
- 零依赖部署:
upload.js仅使用 Node.js 内置模块,无需额外安装包 - 本地资源托管:所有 Docsify 资源(JS/CSS)本地打包,运行时无外部 CDN 依赖
- 智能生命周期管理:支持配置自动过期天数(默认30天),仅作用于
md-web/前缀,不影响桶内其他文件 - 跨平台兼容:支持 Linux/macOS/Windows,自动适配临时目录路径
- 对话体验优化:避免长文本淹没聊天窗口,适合文档分享、内容发布场景
潜在缺点与局限性
- 公开访问风险:上传内容完全公开,严禁包含敏感信息(密钥、PII等)
- 凭证明文存储:
access_key和secret_key以明文保存于用户主目录下的config.json - 权限要求较高:自动过期功能需 S3 API 令牌具备 Admin Read & Write 权限
- 首次配置门槛:需用户自行准备 S3 兼容存储桶并配置 5 项必填参数
- R2.dev 速率限制:未绑定自定义域名时,默认 URL 存在访问频率限制
适合人群
- 需要频繁分享技术文档、API 文档、项目说明的开发者
- 希望将 AI 生成的长内容以网页形式发布的内容创作者
- 团队协作中需要快速生成可分享链接的文档管理者
- 注重数据主权、倾向使用自有云存储的用户
常规风险
| 风险类型 | 说明 | 缓解措施 |
|---------|------|---------|
| 数据泄露 | 误上传敏感文件至公开 URL | 严格审查内容,建立上传前检查清单 |
| 凭证泄露 | `config.json` 被意外提交或共享 | 文件位于用户主目录( skill 目录外),避免随项目提交 |
| 存储桶污染 | 生命周期规则误影响其他对象 | 使用专用存储桶,或确认权限配置正确 |
| 服务可用性 | 依赖用户配置的 S3 服务稳定性 | 选择可靠的存储提供商,监控端点健康状态 |