search

markedjs / marked

A markdown parser and compiler. Built for speed.
https://marked.js.org
Other
32.42k stars 3.37k forks source link

Document i10n? #3360

Open minecraftfen opened 2 weeks ago

minecraftfen commented 2 weeks ago

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 commented 2 weeks ago

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 commented 2 weeks ago

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 commented 2 weeks ago

@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 commented 2 weeks ago

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

minecraftfen commented 2 weeks ago

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

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

minecraftfen commented 2 weeks ago

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 commented 2 weeks ago

And do similar work to doc/index.md