README.md with multi language support?
jinliming2 opened this issue · 35 comments
Sometimes I need to display documents in different languages for different people.
Maybe we can use README.en.md, README.zh.md, README.zh_hans.md, etc to markup language of the document, and determine the display language for users according to browser language.
is it solved?
May not.
I had a wrong operation.
I'm surprised that this isn't available. Definitely adding my +1 for supporting this.
Someone got something new about this needed future?
A workaround would be to put the links to other languages in your default README.md, like in this example.
@kesarion This is a method to solve this problem, but not the best.
I propose to name README using language culture name, e.g. README.zh-CN.md, README.es-ES.md as languages can have cultural differences—like en-US and en-GB.
Might not be a bad idea to use the iso standard.
I think using language culture name is not a good idea for Chinese because even in mainland China there are many language branches, such as Mandarin, Cantonese, Hakka, Xiang, etc. The vast majority of Chinese people are hard to understand more than one language. Just using zh-CN can not distinguish between these languages.
So I think we'd better use this rule: https://www.w3.org/International/articles/language-tags/, with the Language Subtag from IANA: https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry.
But many browsers do not support these language categories, so it is necessary to keep zh. So, for Chinese:
Use zh-Hans for General Simplified Chinese, use zh-Hant for General Traditional Chinese, use zh-cmn-Hans for Mandarin with simplified words, use zh-yue-Hant for Cantonese with traditional words, and so on.
Interested in it too!
Currently, I use README.md, README.zh-Hans.md, README.zh-Hant.md, README.fr.md, etc.
.
Would be very great @github
still waiting, is something I would really like to see.
I would like this feature as well
And is it not added for now?
I would like this feature as well
That would be a gread feature for the readme !
Indeed, READMEs with multi language support would be a very useful feature, hope to see it sometime soon!
In the meantime, I use a single README where each paragraph has its translations one under the other with slightly different styles, for instance one language in italic. A country flag is inserted at the start of each paragraph translation, which makes the README more visually appealing and easier to navigate through. It's not perfect, but it's a decent enough workaround for my purposes. You can see things in action in this repository.
@PyvesB An issue I can see with this is for people who use screen readers, which will read everything in all languages. Another is if you'd like to expand on supporting more languages it will result in a quite heavy README which makes it hard to find and understand the information.
With different README files based on language you can provide a README which doesn't conflict with other languages and make it easier for users (with screen readers too) to understand and parse the information.
With different README files based on language you can provide a README which doesn't conflict with other languages and make it easier for users (with screen readers too) to understand and parse the information.
Yeap, that's what I'm doing on my project.
Opted to use a lang folder where I place the different languages Readme or extra files.
And then I added a menu to choose the language on the top.
@alvarotrigo This reminds me what could be possible with the wiki.
Being able to provide a wiki in multiple languages using something like repo.wiki/lang (using the root wiki repo as a default and /lang for overriding different pages in other languages).
+1 for the example given here, it is easy to follow and the file to be served could be detected based on the location of the user
The thread is closed to be 3 years old and not a single message from dev team :/
+1 folks, where is it!
+1
Hello, Is it possible that github repo recognizes browser's language and links to read file in that language❓
😄 I just wanna doing this process automatically.
And now, it's time for:
🔒 This conversation has been locked to contributors only
This repository is for the github-markup gem, a library which GitHub.com uses to choose a markup processor based on the type of the input data. All questions not related specifically to this gem should go to our support team. (Put another way: if a PR to this repo can't fix it, it doesn't belong here.)
I understand this is something that people want, but opening an issue here won't make that happen. People who work on the code that pertains to your query do not, in general, watch this repository. (I do because I maintain this gem.) To get it in front of their eyes, you'll need to go contact support so they can triage and prioritise it along with other requests.
Thanks for your understanding.