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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feat lang]: Chinese readme (half-way) #199

Closed
wants to merge 3 commits into from
Closed

[feat lang]: Chinese readme (half-way) #199

wants to merge 3 commits into from

Conversation

seognil
Copy link

@seognil seognil commented Dec 6, 2019

Description

Hi, there,

I wrote a Chinese Version of the readme to let more people saw your great work 馃帀
(by add a README_SOURCE-zh.md)
But I'm not sure the doctoc, so other files are untouched

Is there any chance for us to finish the process and merge it?

If okay, I would find some language reviewers.

Changed

  • words description translated line by line
  • code block untouched (maybe working on comments later)
  • toc untouched but auto generated
  • contributors section untouched
  • back to top and some other in-place anchors translated
  • some docs links translated to zh version (tslang.cn & zh-hans.reactjs.org)

Checklist

  • I have read CONTRIBUTING.md
  • I have edited README_SOURCE.md (NOT README.md)
  • I have run CI script locally npm run ci-check to generate an updated README.md
  • I have linked all related issues above
  • I have rebased my branch

@piotrwitek
Copy link
Owner

piotrwitek commented Dec 24, 2019

Hey @seognil.
Oh man, that's really awesome thanks for your incredible work.
I'm really excited about it and I would love to add to the repository.

For now, let's try to merge it ASAP, I'll try to review it right now.

For the near future, I'll think about some more generic way using internationalization techniques to make it easier to improve and maintain the translations.

README_SOURCE-zh.md Outdated Show resolved Hide resolved
@seognil
Copy link
Author

seognil commented Dec 25, 2019

toc seems fixed

I'm also working on scripts for i18n as you mention before

check this https://github.com/seognil-contributor/react-redux-typescript-guide/blob/feat-generate-readme/doctoc.js

@piotrwitek
Copy link
Owner

piotrwitek commented Dec 25, 2019

That looks great, although I was thinking about something better. We could use mdx and some internationalization library, then extract all the text nodes that needs translations into a separate json file.
It should be easier to keep at sync when the guide is extended with a new content and also translating to other languages.

Then we would publish it on the Github pages as a website where you can change languages with a switch. Although don't expect it soon as it would take a lot of time to do.

@seognil
Copy link
Author

seognil commented Dec 26, 2019

wow, you are right, i18n are some serious staff now!
really need to lookup in long run

This pull request was closed.
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.

None yet

2 participants