Skip to content

Commit

Permalink
Doc: Document how to build and translate the help pages
Browse files Browse the repository at this point in the history
  • Loading branch information
laurent22 committed Nov 24, 2023
1 parent 9930359 commit 6244999
Showing 1 changed file with 20 additions and 22 deletions.
42 changes: 20 additions & 22 deletions packages/doc-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

### Local Development
From `packages/tools`, run `node website/processDocs.js --env dev`

```
$ yarn start
### Getting the translations

```shell
CROWDIN_PERSONAL_TOKEN=..... yarn crowdinDownload
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Building the doc

### Build
From `packages/doc-builder`, run:

```
$ yarn build
```shell
WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
Or to build a particular locale:

### Deployment
```shell
WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev --locale fr
```

Using SSH:
`processDocs.js` will also build everything by default, but it takes a long time, so using the above commands is convenient for dev.

```
$ USE_SSH=true yarn deploy
```
## Translation

Not using SSH:
Translation is done using https://crowdin.com/

```
$ GIT_USER=<Your GitHub username> yarn deploy
```
## Building for production

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/

0 comments on commit 6244999

Please sign in to comment.