The official design documentation, containing our custom design system that we use for all products and services. This documentation site runs on Docusaurus, so you may refer to their documentation should you need information on anything that isn't covered here.
- Git
- Node.js & npm
- Yarn
Firstly, clone the repository using Git:
git clone https://github.com/calendso/design.gitNow, you can install the dependencies with yarn:
yarn installTo create, edit and delete documentation pages, you can simply create markdown (.md) files in the docs/ folder. You can edit Markdown with any text editor, but VS Code and WebStorm have side-by-side previews so you can see your formatted content whilst writing markdown.
docusaurus startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn buildThis command generates static content into the build directory and can be served using any static contents hosting service.
GIT_USER=<Your GitHub username> USE_SSH=true yarn deployIf you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.