Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add README-ZH.md #883

Closed
wants to merge 2 commits into from
Closed

add README-ZH.md #883

wants to merge 2 commits into from

Conversation

jadelike-wine
Copy link

add chinese readme file

@HarelM
Copy link
Collaborator

HarelM commented Mar 5, 2024

While i think this is a great addition my main concern is about maintainence. I won't be able to update the Chinese readme and I'm concerned it might drift off.

@jadelike-wine
Copy link
Author

While i think this is a great addition my main concern is about maintainence. I won't be able to update the Chinese readme and I'm concerned it might drift off.

Thank you for your feedback. I understand your concern about maintenance. I would like to assure you that I am committed to regularly maintaining the Chinese documentation.

My company plans to use this GitHub project in the near future and is committed to maintaining and further developing the project. As part of our adoption process, we are committed to maintaining documentation in Chinese to ensure that it remains accurate and up-to-date.

We have a team of developers and technical writers who are proficient in both English and Chinese. We will be regularly reviewing and updating the Chinese documentation to reflect any changes to the project.

We believe that providing high-quality documentation in multiple languages is essential for a successful open source project.

We appreciate your understanding and support.

@nyurik
Copy link
Member

nyurik commented Mar 5, 2024

Thx, I would love to have translated documentation, but I think the documentation is different from the Readme. Perhaps we should setup a mdbook in multiple languages?

@sharkAndshark
Copy link

sharkAndshark commented Mar 5, 2024

Like the mdbook idea. I find it's difficult to introduce this tool to my ArcGIS friends. Maybe a nice book could help them.

@HarelM
Copy link
Collaborator

HarelM commented Mar 5, 2024

In maplibre-gl-js we are using mkdocs material, which works great, it also allowed embedding JavaScript if needed.
From a short googling it seems like mdbook still doesn't support multi language, but I might be wrong, mkdocs does seem to support it:
https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/

rust-lang/mdBook#5

I haven't tested multiple languages support in either, and in general, both are using markdown, so hopefully we will be able to change it as needed.

@nyurik
Copy link
Member

nyurik commented Mar 5, 2024

Comprehensive Rust used .po files (info) - seems interesting (they actually mentioned it in the link you gave here), but this is a JS project, so if mkdocs works well - lets do that. @jadelike-wine would you be interested in starting that translation effort / setting up a doc site / help with translation there? Thx!

@sharkAndshark
Copy link

I'd love to help review the translation. I think my Chinese is not bad lolll

@jadelike-wine
Copy link
Author

Comprehensive Rust used .po files (info) - seems interesting (they actually mentioned it in the link you gave here), but this is a JS project, so if mkdocs works well - lets do that. @jadelike-wine would you be interested in starting that translation effort / setting up a doc site / help with translation there? Thx!

Ok, let me try to create a Mkdocs。we can do like this picture(https://squidfunk.github.io/mkdocs-material/assets/screenshots/language-selection.png)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants