VSCode Share
VSCode 扩展 - 将 Markdown 文档分享为 HTML
功能特性
Markdown 功能
- 分享为 HTML:转换为 HTML 并上传到云端
- 分享到 Confluence(创建子页面):在指定页面下创建子页面
- 分享到 Confluence(更新页面):更新指定页面内容
- 使用 marked 库将 Markdown 转换为 HTML/Confluence 格式
- 支持 Mermaid 图表渲染
- 可选择在本地生成同名 HTML 文件
HTML 功能
- 分享 HTML:直接分享现有 HTML 文件到云端
- 分享到 Confluence(创建子页面):将 HTML 内容创建为 Confluence 子页面
- 分享到 Confluence(更新页面):用 HTML 内容更新指定 Confluence 页面
- 自动清理 HTML 中的样式和脚本,适配 Confluence 格式
- 提供复制链接和浏览器打开功能
通用功能
- 详细的进度提示和错误处理
- 支持深色/浅色主题自动切换
- 完整的 Mermaid 图表支持
- 优美的响应式设计和排版
- 自动使用文件名作为文档标题
- Confluence 重名自动处理(自动添加时间戳重试)
使用方法
Markdown 文档分享
- 打开任意 Markdown 文档
- 在编辑器中右键点击
- 选择"分享为 HTML"菜单项
- 等待转换和上传完成
- 在弹出的对话框中选择复制链接或在浏览器中打开
HTML 文档分享
- 打开任意 HTML 文档
- 在编辑器中右键点击
- 选择对应的分享选项:
- 分享 HTML:上传到云端获取分享链接
- 分享到 Confluence(创建子页面):在指定父页面下创建子页面
- 分享到 Confluence(更新页面):更新指定页面内容
- 如果选择 Confluence 选项,输入页面 ID
- 等待操作完成
- 在弹出的对话框中选择复制链接或在浏览器中打开
Confluence 分享
- 打开任意 Markdown 文档
- 在编辑器中右键点击
- 选择对应的 Confluence 分享选项:
- 创建子页面:在指定父页面下创建新的子页面
- 更新页面:更新指定页面的内容
- 输入页面 ID(可在 Confluence 页面 URL 中找到)
- 等待操作完成
- 在弹出的对话框中选择复制链接或在浏览器中打开
配置选项
- 打开 VSCode 设置(Ctrl+,)
- 搜索 "vscode share"
- 可配置以下选项:
- Generate Local Html:启用后分享 Markdown 时会同时生成本地 HTML 文件
- Confluence Url:Confluence 服务器地址(默认:https://kb.cvte.com/)
- Confluence Username:Confluence 用户名
- Confluence Api Token:Confluence API Token(在 Confluence 个人设置中生成)
技术栈
- TypeScript
- VSCode Extension API
- marked (Markdown 解析)
- axios (HTTP 请求)
- Mermaid (图表支持)
注意事项
- Markdown 功能仅在 .md 文件中生效
- HTML 功能仅在 .html 文件中生效
- 需要网络连接才能上传到云端
- 上传的 HTML 包含完整的样式和 Mermaid 支持
- 本地 HTML 生成功能需要文件保存权限
| |