- 首先,为你的 GitHub 项目创建一个 **
docs
** 文件夹,用于存放不同语言版本的文档。 - 在 **
docs
文件夹内创建两个子文件夹:一个是en
(用于存放英文文档),另一个是zh
(用于存放中文文档)。在这两个文件夹中分别创建对应语言的 README 文件,例如README-en.md
和README-zh.md
**。 - 在项目的根目录中创建一个默认的 **
README.md
**,用于显示项目的主要信息和切换语言的链接。在文件开头添加以下代码:
[English](./docs/en/README-en.md) | [中文](./docs/zh/README-zh.md)
这段代码将创建两个链接,分别指向英文和中文文档。你可以根据需要调整链接文本和指向的文件路径。
- 在英文文档 **
README-en.md
和中文文档README-zh.md
** 的开头,也添加类似的切换链接:
英文文档 **README-en.md
** 开头添加:
[English](./README-en.md) | [中文](../zh/README-zh.md)
中文文档 README-zh.md 开头添加:
[English](../en/README-en.md) | [中文](./README-zh.md)
- 接下来,你需要分别为 **
README-en.md
和README-zh.md
** 添加对应语言的项目介绍和使用说明。
完成以上步骤后,当用户点击对应的链接时,就可以在英文和中文文档之间切换了。