* Initial commit for i18n support * Bring out index page * Lint modified: src/pages/index.js * More Crowdin ephemera * copy src content to i18n/**/docusaurus-plugin-content-docs/current folders * run write-translations * remove superflous files in i18n * fix formatting * remove icons folders from translations, add ja, pt, vi translations * fix formatting * update translation JSON files * add crowdin support & crowdin:sync command, sync with crowdin * exclude failing locales * remove i18n from git cache, add write-heading-ids script * add crowdin:sync to before_install.sh script * add write-i18m shortening script & crowdin:download script (also to before_install.sh) * move crowdin:download from before_install.sh to prebuild hook * remove prebuild hook * remove crowdin script, bump deps * re-add cli/usage * update package-lock.json * add translation sync to build.sh for master * update README * add ja to localesNotBuilding, write e-ids * fix formatting * get on sync with master * replace check for master branch * change build script to work on travis * use refs instead of names * fix build.sh * replace head ref check with channel check * get stable channel in build.sh * remove zip * remove header ids Co-authored-by: rmshea <8948187+rmshea@users.noreply.github.com>
This commit is contained in:
@ -5,7 +5,7 @@ Static content delivery is handled using `vercel`.
|
||||
|
||||
### Installing Docusaurus
|
||||
|
||||
```
|
||||
```sh
|
||||
$ npm install
|
||||
```
|
||||
|
||||
@ -15,7 +15,7 @@ This command starts a local development server and open up a browser window.
|
||||
Most changes are reflected live without having to restart the server.
|
||||
(You might have to run build.sh first if you run into failures)
|
||||
|
||||
```
|
||||
```sh
|
||||
$ npm run start
|
||||
```
|
||||
|
||||
@ -24,10 +24,28 @@ $ npm run start
|
||||
This command generates static content into the `build` directory and can be
|
||||
served using any static contents hosting service.
|
||||
|
||||
```
|
||||
```sh
|
||||
$ docs/build.sh
|
||||
```
|
||||
|
||||
### Translations
|
||||
|
||||
Translations are sourced from [Crowdin](https://docusaurus.io/docs/i18n/crowdin)
|
||||
and generated when master is built.
|
||||
For local development use the following two commands in the `docs` directory.
|
||||
|
||||
To download the newest Documentation translations run:
|
||||
|
||||
```sh
|
||||
npm run crowdin:download
|
||||
```
|
||||
|
||||
To upload changes from `src` & generate [explicit IDs](https://docusaurus.io/docs/markdown-features/headings#explicit-ids):
|
||||
|
||||
```shell
|
||||
npm run crowdin:upload
|
||||
```
|
||||
|
||||
### CI Build Flow
|
||||
|
||||
The docs are built and published in Travis CI with the `docs/build.sh` script.
|
||||
|
Reference in New Issue
Block a user