riotjs.com is our documents site for Riot.js.
If you’d like to contribute to improve or translate the docs, you can fork this repo, commit your changes, & send a pull request.
Send a pull request to the master branch.
In short:
- add translation into directory named your language
- send a pull request to
lang/vesionbranch
For example fr/v2.2.4 or ja/v2.3.0.
If there's no translation yet, follow the instruction below.
- Make a new issue about translation like this
- Pick your language code. For example:
ja,zh,es,de, ...etc. - Collaborators will make a new branch for translation. For example
fr/v2.2.4orja/v2.3.0. - Fork the branch, and add some files and directories below.
- Send pull request to the branch. You don't have to complete. It's OK if it's on the way.
- Make a new directory at
/(root) with the name from your language code. For example: /ja/ - Put your translated files into your directory. Follow the original structure. For example:
- Make some HTML parts in
/_includes/. Create a new directory there and put these files into it. For example: - Make a Jekyll template for your language in
/_layouts/. For example:
See Jekyll document. Don't worry, easy steps. Basically just two:
$ sudo gem install jekyll$ jekyll serveat the root directory of this project.
If you use Windows, check this instruction, too.
- Send PR to
masterbranch and let someone merge it. (PR is preferred way, but, maintainer can merge it directly if the change is small) - Remove working branch: ex.
fr/v2.2.4orja/v2.3.0 - Add tag: ex.
v2.2.4-frorv2.3.0-ja
- We're discussing about Tagging and branching convention.
- Don't work hard alone, invite your friend as a translator or a reviewer.
- Make a team for your language!
- No need to translate v1.0 docs
- For translations into languages with T–V distinction, it is recommend to use V-form.