7.VSCode 多语言文档翻译辅助工具

I18n Docs Helper

VSCode 多语言文档翻译辅助工具,这个插件是我自己开发自己使用的,就是配合 nextra 来辅助管理多语言的文档的,使用下来效率很高

i18n-docs-helper

插件位置

plugin & script/i18n-docs-helper.vsix

功能特性

  1. 状态栏控制

    • 在 VSCode 底部状态栏显示插件状态和当前激活的语言
    • 点击状态栏图标打开功能菜单
    • 可快速切换插件启用/禁用状态
    • 支持配置激活的语言列表
  2. 翻译文件管理

    • 右键菜单中检查缺失的翻译文件
    • 一键创建所有缺失的翻译文件
    • 自动使用默认语言作为模板
    • 显示详细的创建结果报告
  3. 多语言文件同步编辑

    • 右键菜单快速打开其他语言对应文件
    • 支持保留/关闭其他已打开的窗口
    • 支持光标位置同步功能
    • 可在状态栏菜单中开启/关闭同步功能
  4. 链接检查功能

    • 检查 Markdown 链接 [text](link) 和图片链接 ![alt](image)
    • 检查 HTML 属性中的链接:href=""src=""file=""
    • 验证文档链接的语言标识符
    • 确保链接指向正确的语言目录
    • 自动检查资源文件是否存在
    • 提供可点击的错误位置导航

安装方法

  1. 将插件目录复制到 VSCode 扩展目录:

install-plugin

  1. 重启 VSCode

使用方法

  1. 状态栏功能

    • 点击底部状态栏的 “I18n Helper” 图标打开功能菜单
    • 在菜单中可以:
      • 切换插件启用状态
      • 开启/关闭光标同步
      • 配置激活的语言
      • 检查缺失文件
  2. 右键菜单功能

    • “打开所有语言版本”:在新窗口打开其他语言文件
    • “打开所有语言版本(关闭其他窗口)“:关闭其他窗口后打开
    • “检查缺失的翻译文件”:检查并可选择创建缺失文件
    • “检查文档链接”:验证当前文件中的所有链接
  3. 光标同步功能

    • 在状态栏菜单中开启同步功能
    • 移动任意窗口的光标,其他语言窗口会同步到相同位置
    • 保持所有窗口中的对应行位置一致
  4. 语言管理

    • 可以设置默认语言作为创建文件的模板
    • 可以配置激活的语言列表,只对特定语言启用功能
    • 支持动态切换激活的语言
  5. 链接检查规则

    • 文档链接必须包含正确的语言标识符(如 /en/docs/guide
    • 链接语言必须与当前文件语言匹配
    • 资源文件链接会在配置的资源目录中查找
    • 支持检查以下类型的链接:
      • Markdown 文档链接:[text](/zh/docs/guide)
      • Markdown 图片链接:![alt](/images/photo.jpg)
      • HTML href 属性:<a href="/zh/docs/guide">
      • HTML src 属性:<img src="/images/photo.jpg">
      • HTML file 属性:<link file="/docs/style.css">

快捷键设置

不过由于是自用插件,所以不保证功能正常工作

可以在 VSCode 键盘快捷方式中设置以下命令的快捷键:

  • i18n-docs-helper.toggleEnable: 切换插件启用状态
  • i18n-docs-helper.toggleSyncScroll: 切换光标同步
  • i18n-docs-helper.checkMissingTranslations: 检查缺失翻译
  • i18n-docs-helper.createMissingFiles: 创建缺失文件
  • i18n-docs-helper.openTranslationFiles: 打开所有语言版本
  • i18n-docs-helper.openTranslationFilesAndClose: 打开所有语言版本(关闭其他窗口)
  • i18n-docs-helper.configureActiveLanguages: 配置激活的语言
  • i18n-docs-helper.checkLinks: 检查文档链接