zitadel/docs
Livio Amstutz fef9eb91f9
docs: add swagger editor links (#2657)
* docs: add swagger editor links

* Apply suggestions from code review

Co-authored-by: Florian Forster <florian@caos.ch>

Co-authored-by: Florian Forster <florian@caos.ch>
2021-11-11 13:56:16 +01:00
..
docs docs: add swagger editor links (#2657) 2021-11-11 13:56:16 +01:00
src docs(apis): cleanup navigation, better overview (#2608) 2021-11-02 14:05:47 +01:00
static docs: quickstart, guides overview (#2524) 2021-10-18 19:37:29 +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: quickstart, guides overview (#2524) 2021-10-18 19:37:29 +00:00
package.json docs: Admin training (#2436) 2021-09-30 11:49:57 +02:00
README.md docs: restructure and add more content (#2232) 2021-09-23 10:34:06 +02:00
sidebars.js docs(apis): cleanup navigation, better overview (#2608) 2021-11-02 14:05:47 +01:00
yarn.lock docs: Admin training (#2436) 2021-09-30 11:49:57 +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 automatically built with a preview link from cloudflare pages. Visit the checks / comments on the PR for the link.