版本化

将旧版本的文档放在文档目录中,最新版本的位置不变:

docs/
├── en/          # 最新版本
│   └── guide/
├── zh/
└── v1/          # 旧版本
    ├── en/
    │   └── guide/
    └── zh/

没有开启国际化时,旧版本的文档直接放在 docs/v1 中。

然后在配置文件中列出旧版本,新的在前:

{
  "versions": ["v2", "v1"]
}
  • 旧版本的页面以版本为前缀,例如 /zh/v1/guide,最新版本保持 /zh/guide
  • 导航栏中显示版本选择器,切换到该版本的首页
  • 旧版本的页面会显示提示,链接到最新版本中的同一页面
  • 旧版本不需要包含所有语言
  • 搜索和 llms.txt 只包括最新版本