首页
/ Vitepress国际化配置指南:自定义文档标签与搜索提示

Vitepress国际化配置指南:自定义文档标签与搜索提示

2025-05-16 16:05:58作者:凤尚柏Louis

理解Vitepress的国际化机制

Vitepress作为基于Vue的静态站点生成器,提供了完善的国际化支持,允许开发者自定义界面中的各种文本内容。在实际项目中,我们经常需要修改默认的界面文本,例如将"Doc"改为其他语言或自定义标签,或者调整搜索框的提示文字。

配置文档大纲标签

Vitepress的文档大纲(Outline)部分默认显示"On this page"文本,可以通过主题配置进行修改。在.vitepress/config.js文件中,我们可以这样配置:

export default {
  themeConfig: {
    outline: {
      label: '本文目录'  // 将默认的"On this page"改为中文
    }
  }
}

自定义本地搜索国际化

对于搜索功能的文本定制,Vitepress提供了search配置项。我们可以通过以下方式修改搜索框的提示文字和搜索结果中的相关文本:

export default {
  themeConfig: {
    search: {
      provider: 'local',
      options: {
        translations: {
          button: {
            buttonText: '搜索文档',
            buttonAriaLabel: '搜索文档'
          },
          modal: {
            noResultsText: '无法找到相关结果',
            resetButtonTitle: '清除搜索条件',
            footer: {
              selectText: '选择',
              navigateText: '切换'
            }
          }
        }
      }
    }
  }
}

高级国际化实践

对于更复杂的多语言场景,Vitepress支持完整的国际化配置。我们可以为每种语言创建单独的配置:

export default {
  locales: {
    '/zh/': {
      lang: 'zh-CN',
      themeConfig: {
        outline: { label: '本文目录' },
        search: {
          provider: 'local',
          options: {
            translations: {
              button: { buttonText: '搜索' }
            }
          }
        }
      }
    },
    '/en/': {
      lang: 'en-US',
      themeConfig: {
        outline: { label: 'On this page' },
        search: {
          provider: 'local',
          options: {
            translations: {
              button: { buttonText: 'Search' }
            }
          }
        }
      }
    }
  }
}

注意事项

  1. 确保配置层级正确,search配置应位于themeConfig下
  2. 修改后需要重启开发服务器才能看到效果
  3. 对于生产环境,构建后才会完全生效
  4. 某些文本可能需要同时修改ARIA标签以保证无障碍访问

通过以上配置,开发者可以轻松实现Vitepress项目的全面国际化,创建符合不同地区用户使用习惯的文档网站。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
atomcodeatomcode
Claude Code 的开源替代方案。连接任意大模型,编辑代码,运行命令,自动验证 — 全自动执行。用 Rust 构建,极致性能。 | An open-source alternative to Claude Code. Connect any LLM, edit code, run commands, and verify changes — autonomously. Built in Rust for speed. Get Started
Rust
434
76
docsdocs
暂无描述
Dockerfile
690
4.46 K
kernelkernel
openEuler内核是openEuler操作系统的核心,既是系统性能与稳定性的基石,也是连接处理器、设备与服务的桥梁。
C
407
326
pytorchpytorch
Ascend Extension for PyTorch
Python
547
671
kernelkernel
deepin linux kernel
C
28
16
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.59 K
925
ops-mathops-math
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
955
930
communitycommunity
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
650
232
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.08 K
564
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
C
436
4.43 K