self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-18 09:35:20 +02:00
Code Issues Releases Activity
35849b1d34
joplin/packages/doc-builder
History
Laurent Cozic 6244999899 Doc: Document how to build and translate the help pages
2023-11-24 20:02:46 +01:00
..
src Doc: Refactored documentation, split it into smaller articles, and added search (#9132) 2023-10-30 11:32:14 +00:00
static Doc: Refactored documentation, split it into smaller articles, and added search (#9132) 2023-10-30 11:32:14 +00:00
.gitignore Doc: Add support for localisation using Crowdin 2023-10-31 11:32:55 +00:00
babel.config.js Doc: Refactored documentation, split it into smaller articles, and added search (#9132) 2023-10-30 11:32:14 +00:00
docusaurus.config.js Doc: Fixed favicon on translated websites 2023-11-05 17:59:35 +00:00
package.json Doc: Refactored documentation, split it into smaller articles, and added search (#9132) 2023-10-30 11:32:14 +00:00
README.md Doc: Document how to build and translate the help pages 2023-11-24 20:02:46 +01:00
sidebars.js Doc: Refactored documentation, split it into smaller articles, and added search (#9132) 2023-10-30 11:32:14 +00:00

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Development

Generating the MDX files

From packages/tools, run node website/processDocs.js --env dev

Getting the translations

CROWDIN_PERSONAL_TOKEN=..... yarn crowdinDownload

Building the doc

From packages/doc-builder, run:

WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev

Or to build a particular locale:

WEBSITE_BASE_URL=http://localhost:8077 yarn buildDev --locale fr

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

Translation

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

Building for production

This is done in release-website.sh from the repository https://github.com/joplin/website/