国际化

由于 Docute 使用基于 URL 的 API实现,因此添加多语言支持非常简单:

  1. docs
  2. ├─ README.md
  3. ├─ foo.md
  4. ├─ nested
  5. └─ README.md
  6. └─ zh
  7. ├─ README.md
  8. ├─ foo.md
  9. └─ nested
  10. └─ README.md

使用上述文件夹结构,用户可以通过 URL /zh/ 访问文档的中文版本。

然后,可以使用 overrides 选项来本地化 UI 中使用的文本:

  1. new Docute({
  2. sidebar: [
  3. {
  4. links: [
  5. { title: 'Guide', link: '/guide' }
  6. ]
  7. }
  8. ],
  9. overrides: {
  10. '/': {
  11. language: 'English' // Used by the language dropdown menu in the sidebar
  12. },
  13. '/zh/': {
  14. language: 'Chinese',
  15. // Override the default sidebar
  16. sidebar: [
  17. {
  18. links: [
  19. { title: '指南', link: '/zh/guide' }
  20. ]
  21. }
  22. ]
  23. }
  24. }
  25. })