Cookei

Cookei

HomeArchives

Create a bilingual Readme document.

221
AI Translation
This post is translated from Chinese into English through AI.View Original
AI-generated summary
To create multilingual documentation for your GitHub project, first create a "docs" folder. Inside the "docs" folder, create two subfolders: one for English documentation and one for Chinese documentation. In each subfolder, create a README file specific to the language. In the project's root directory, create a default README file with links to switch between languages. Add the code "English | 中文" at the beginning of each README file. Finally, add the project introduction and instructions in the respective language to each README file. Users can then switch between English and Chinese documentation by clicking on the links.
  1. First, create a docs folder for your GitHub project to store documentation in different language versions.
  2. Create two subfolders within the docs folder: one for English documentation (en) and another for Chinese documentation (zh). In each of these folders, create a README file for the respective language, such as README-en.md and README-zh.md.
  3. In the root directory of the project, create a default README.md file to display the main information of the project and provide links to switch between languages. Add the following code at the beginning of the file:
[English](./docs/en/README-en.md) | [中文](./docs/zh/README-zh.md)

This code will create two links, one for English and one for Chinese documentation. You can adjust the link text and file paths as needed.

  1. In the beginning of the English documentation file README-en.md, add similar switch links:
[English](./README-en.md) | [中文](../zh/README-zh.md)

In the beginning of the Chinese documentation file README-zh.md, add:

[English](../en/README-en.md) | [中文](./README-zh.md)
  1. Next, you need to add the project introduction and usage instructions in the respective language to README-en.md and README-zh.md.

After completing these steps, users will be able to switch between English and Chinese documentation by clicking on the corresponding links.

Loading...
Ownership of this post data is guaranteed by blockchain and smart contracts to the creator alone.