Skip to content

Commit

Permalink
update contributing guide of translations (#2262)
Browse files Browse the repository at this point in the history
  • Loading branch information
uiolee authored Oct 14, 2024
1 parent d8e57a7 commit 2650a2b
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 22 deletions.
24 changes: 9 additions & 15 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,23 @@
- [ ] Others (Update, fix, translation, etc...)
- Languages:
- [ ] `en` English
- [ ] `ru` Russian
- [ ] `zh-cn` simplified Chinese
- [ ] `zh-tw` traditional Chinese
- [ ] `ja` Japanese


<!--
> **Note**
>
> No need to translate `ko`, `pt-br`, `th` languages if you submit a PR for documentation.
> **Warning**
>
> `ko`, `pt-br`, `th` languages document are inactive. Please, submit issue if you want to continuous contribution to them.
> Now we use [Crowdin](https://crowdin.com/project/hexo) platform for translation, you should submit your translation there.
> You don't need to submit the translation to github
-->

<!--
<!--
Thank you for publishing your work on Hexo site!
If you also would like to become a Hexojs org memeber, here is the opportunity. Simply transfer your repo into Hexojs org, and you will become hexojs member. You could still be the repo admin, but also gain access to hexojs other repoes.
If you also would like to become a Hexojs org memeber, here is the opportunity. Simply transfer your repo into Hexojs org, and you will become hexojs member. You could still be the repo admin, but also gain access to hexojs other repoes.
There are several benefits to do so:
1. Become Hexojs org member, and gain access to all hexojs repos.
2. Other Hexojs members could help to maintain issues and review PRs.
3. More wait you to discover... :)
Please contact [email protected] if you are interested in this opportunity.
-->
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,32 @@ The website for Hexo.

Install dependencies:

``` bash
```bash
git clone https://github.com/hexojs/site.git
cd site
npm install
```

Generate:

``` bash
```bash
hexo generate
```

Run server:

``` bash
```bash
hexo server
```

## Contributing

Before you open pull requests, please refer to the guide:

- [Add your plugin to `hexo.io/plugins/`](https://hexo.io/docs/plugins#Publishing)
- [Add your theme to `hexo.io/themes/`](https://hexo.io/docs/themes#Publishing)
- [Update Documentation](https://hexo.io/docs/contributing#Updating-Documentation)

## Contributors

- English - [tommy351](https://github.com/tommy351)
Expand Down
16 changes: 12 additions & 4 deletions source/docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,10 +87,18 @@ $ hexo server

### Translating

1. Add a new language folder in `source` folder. (All lower case)
2. Copy Markdown and template files in `source` folder to the new language folder.
3. Add the new language to `source/_data/language.yml`.
4. Copy `en.yml` in `themes/navy/languages` and rename it to the language name (all lower case).
#### Contribute translations

[![Crowdin](https://badges.crowdin.net/hexo/localized.svg)](https://crowdin.com/project/hexo)

Now we use the [Crowdin](https://crowdin.com/project/hexo) platform for translation, where anyone can contribute translations and vote for translations without manual git operations.

#### Add a new language

1. Summit a new issue to let us know. The members with access to the [Crowdin Project](https://crowdin.com/project/hexo) add the language in settings.
1. After adding language in Crowdin, anyone can contribute translations on it.
1. Add the new language to [`source/_data/language.yml`](https://github.com/hexojs/site/blob/master/source/_data/languages.yml).
1. Copy `en.yml` in [`themes/navy/languages`](https://github.com/hexojs/site/tree/master/themes/navy/languages) and rename it to the language name (all lower case).

## Reporting Issues

Expand Down

0 comments on commit 2650a2b

Please sign in to comment.