zitadel/docs
Fabi 12f128e3c5
docs: api request descriptions (#1637)
* doc: api descriptions

* doc: management description

* doc: message validation

* doc: api descriptions

* doc: api descriptions

* doc: description

* doc: index images

* doc: design

* colors, colors and more colors

* margin

* fix comment

* doc: api descriptions

* doc: empty response

* doc: api descriptions

* fix comment

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2021-04-22 12:59:17 +00:00
..
docs docs: api request descriptions (#1637) 2021-04-22 12:59:17 +00:00
src docs: api request descriptions (#1637) 2021-04-22 12:59:17 +00:00
static docs: api request descriptions (#1637) 2021-04-22 12:59:17 +00:00
.gitignore docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00
babel.config.js docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00
docusaurus.config.js docs: api request descriptions (#1637) 2021-04-22 12:59:17 +00:00
package-lock.json docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00
package.json docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00
README.md docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00
sidebars.js fix(console): link to quickstarts (#1631) 2021-04-21 21:46:13 +02:00
yarn.lock docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00

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

This command starts a local development server and open 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

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