agdolla / developer

The official developer documentation.

Website · Community Support

Developer Documentation

The official developer documentation, containing information and guides about building on top of and extending Calendso. This documentation site runs on Docusaurus, so you may refer to their documentation should you need information on anything that isn't covered here.

Prerequisites

• Git
• Node.js & npm
• Yarn

Installation

Firstly, clone the repository using Git:

git clone https://github.com/calendso/developer.git

Now, you can install the dependencies with yarn:

yarn install

Editing

To 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.

Local Development

docusaurus start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.