mirror of https://github.com/laurent22/joplin.git synced 2024-11-27 08:21:03 +02:00

History

Laurent Cozic 5f6370d7ba Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )		2023-10-30 11:32:14 +00:00
..
processDocsTestSamples	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00
utils	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00
build.ts	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00
buildTranslations.ts	Tools: Make main website translatable	2022-11-28 17:18:15 +01:00
processDocs.test.ts	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00
processDocs.ts	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00
README.md	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00
updateDownloadPage.ts	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00
updateNews.ts	Doc: Refactored documentation, split it into smaller articles, and added search (#9132 )	2023-10-30 11:32:14 +00:00

README.md

Joplin Website Builder

The website is mostly built by rendering Markdown files under /readme to HTML. More advanced pages such as the homepage or Plans page are created using a Mustache template.

Docusaurus is used to build the Help and News pages.

To build the website

Run yarn buildWebsite, which will run all the required commands in the correct order. This will create the website in a relative directory ../joplin-website/docs.

To watch the website

To watch the website run yarn watchWebsite. If changing the Help or News pages, run yarn start from packages/doc-builder.