This project contains all platform related documentation, a knowledge base and information (blog posts) on new releases. https://office.thinkwisesoftware.com/docs/
Please use the vscode-markdownlint extension.
Built with Docusaurus.
For detailed requirements and instructions, see the Docusaurus docs.
-
Install Docusaurus
yarn install
-
Start the website
yarn start
See the markdownlint rules. Some overrides are defined in the .markdownlint.json configuration file.
New pages need to be registered in sidebars.json.
Start every page with a YAML front matter title definition. This title is displayed in the sidebar and at the top of the page.
---
title: Title of the page
---Start with level two ## heading and always increment headings by one level.
Images are stored in the /docs/assets folder and must be referenced like this: assets/image.png. Don't use relative paths like ../assets/image.png as this breaks the versioning.
See the Docusaurus documentation for more information.
To preview changes, select the Next version from the versions page. A netlify preview is automatically created for every pull request.