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

Document i10n? #3360

Open
minecraftfen opened this issue Jul 5, 2024 · 7 comments
Open

Document i10n? #3360

minecraftfen opened this issue Jul 5, 2024 · 7 comments
Labels
category: docs Documentation changes

Comments

@minecraftfen
Copy link

Describe the feature

I'm a Chinese Student, and I'm working on translating marked official document into Chinese for some reason. Are you willing to accept these translations for other Chinese language developers? Or if I publish these translations on my Github Pages, can you leave a link on the official website?

Why is this feature necessary?

If I only post these contents on my own website, I may not be able to help others, and you can also place translations from other languages/versions in the footer for the convenience of others to use.

Describe alternatives you've considered

Well I think I have already done it in Describe the feature

@UziTech
Copy link
Member

UziTech commented Jul 5, 2024

Ya that sounds cool. The more people that can read the docs the better.

Our docs are built with marked in https://github.com/markedjs/marked/tree/master/docs would we have a cn directory with the translations?

@minecraftfen
Copy link
Author

Ya that sounds cool. The more people that can read the docs the better.

Our docs are built with marked in https://github.com/markedjs/marked/tree/master/docs would we have a cn directory with the translations?

I'm still working on it; I will make I fork of marked repo so you can check my progress.

My current translation does not reference the original Markdown file but was written from scratch with the compiled version, and there may be minor markup changes in the translation.

@minecraftfen
Copy link
Author

minecraftfen commented Jul 6, 2024

@UziTech I usually work on personal projects and I'm not very clear about collaboration on Github, and I was wondering, if someone wants to point out mistakes of my Chinese translations, how should they find me through Issues?

@UziTech
Copy link
Member

UziTech commented Jul 6, 2024

Maybe add something to the README like "Chinese translations by @minecraftfen"

@minecraftfen
Copy link
Author

Maybe add something to the README like "Chinese translations by @minecraftfen"

You reminded me, maybe I can add another translation of README too.

@minecraftfen
Copy link
Author

I will put a translation switch on README.md like this:

English | [简体中文](./README.zh-cn.md) | [Translations List](./README.langs.md)

README.langs.md:

# marked readme.md translations list

|Language|Author|Translated from Version|Last Updated|
|:--|:--|:--|:--|
|[English](./README.md)|[markedjs](https://github.com/markedjs)|(Original Version)|--|
|[简体中文](./README.zh-cn.md)|[minecraftfen](https://github.com/minecraftfen)|[Nov 28, 2023](https://github.com/markedjs/marked/commit/4f3304018e104d43b29dcd81a9fcf78d8c3ea52b)|WIP|

@minecraftfen
Copy link
Author

And do similar work to doc/index.md

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

No branches or pull requests

2 participants