1
0
mirror of https://github.com/laurent22/joplin.git synced 2024-11-24 08:12:24 +02:00

Doc: Document how to build and translate the help pages

This commit is contained in:
Laurent Cozic 2023-11-24 20:01:28 +01:00
parent 9930359210
commit 6244999899

View File

@ -2,40 +2,38 @@
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
## Development
```
$ yarn
### Generating the MDX files
From `packages/tools`, run `node website/processDocs.js --env dev`
### Getting the translations
```shell
CROWDIN_PERSONAL_TOKEN=..... yarn crowdinDownload
```
### Local Development
### Building the doc
```
$ yarn start
From `packages/doc-builder`, run:
```shell
WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Or to build a particular locale:
### Build
```
$ yarn build
```shell
WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev --locale fr
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
`processDocs.js` will also build everything by default, but it takes a long time, so using the above commands is convenient for dev.
### Deployment
## Translation
Using SSH:
Translation is done using https://crowdin.com/
```
$ USE_SSH=true yarn deploy
```
## Building for production
Not using SSH:
```
$ GIT_USER=<Your GitHub username> yarn deploy
```
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
This is done in `release-website.sh` from the repository https://github.com/joplin/website/