self-hosted/joplin
1
0
Fork 0
mirror of https://github.com/laurent22/joplin.git synced 2024-12-24 10:27:10 +02:00
Code Issues Releases Activity
28c7268f82
joplin/packages/tools/website
History
Laurent Cozic 28fd9c3039
Tools: Spellcheck Markdown documents (#10004)
2024-02-26 16:53:48 +00:00
..
processDocsTestSamples Tools: Spellcheck Markdown documents (#10004) 2024-02-26 16:53:48 +00:00
utils Chore: Implement cSpell to detect spelling mistakes in codebase (#10001) 2024-02-26 10:16:23 +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: Add support for localisation using Crowdin 2023-10-31 11:32:55 +00:00
processDocs.ts Doc: Fixes #9216: Fixed several broken links 2023-11-05 17:59:36 +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: Automatically detect Apple silicon on Download page 2023-11-03 12:36:43 +00:00
updateNews.ts Chore: Implement cSpell to detect spelling mistakes in codebase (#10001) 2024-02-26 10:16:23 +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.