zitadel/docs
Florian Forster dfc9488bb5
docs: rework documentation site (#1589)
* initial commit

* inital changes

* commit WIP Information Architecture

* commit a working state

* add static assets and project

* add org and fix img names

* add plausible

* remove img

* change sidebar to easier mgmt

* add openid oauth and domains

* lint md

* quickstarts

* add auth flow

* identity brokering

* remove site

* fix broken links

* extend footer

* extend readme

* fix: styling

* fix: zitadel logo on index

* styling

* border

* fix: nav

* fix: nav

* fix: index

* fix: rename architecture to concepts

* fix: introductions

* fix: introductions

* fix: introductions

* fix: get started

* fix: user manual

* fix: zitadel architecture

* fix: dead links

* add favicon

Co-authored-by: fabi <fabienne.gerschwiler@gmail.com>
Co-authored-by: Livio Amstutz <livio.a@gmail.com>
2021-04-15 13:22:37 +02:00
..
docs docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00
src docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02:00
static docs: rework documentation site (#1589) 2021-04-15 13:22:37 +02: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: rework documentation site (#1589) 2021-04-15 13:22:37 +02: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 docs: rework documentation site (#1589) 2021-04-15 13:22:37 +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.