Skip to content

moonsama/docs

Repository files navigation

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn 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.

Please make sure the build succeeds locally before pushing your modifications.

Contribute

We follow the well known Git flow.

TL;DR:

  1. Fork the repo.
  2. Create a branch for your modifications, branching off from dev
  3. Make your changes and push
  4. Open a pull request to the dev branch.

For smaller things you can also edit documents in-place on GitHub.