zitadel/docs/README.md
2022-10-27 18:16:04 +02:00

1.1 KiB

Netlify Status

Website

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

Add new Sites to existing Topics

To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.

Installation

yarn install

Local Development

yarn start

As an alternative you can use this docker compose command:

docker compose up

These commands start a local development server. 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

Each PR will be automatically built with a preview link from cloudflare pages. Visit the checks / comments on the PR for the link.