zitadel/docs/README.md
Fabi c8d59ee488
docs: restructure and add more content (#2232)
* docs: restructure quickstarts

* docs: quickstart libs

* docs: add exlixir lib

* docs: restructure

* docs: restructure

* docs: customization

* use tabs in oauth/oidc endpoints.md

* improve authorize_endpoint

* improve token_endpoint and introspection_endpoint

* docs: saas use case

* styling

* styling

* begin login users

* login users

* login users

* fix table

* fix: links

* fix: links

* start go api

* fix: policy structure

* fix: saas description

* fix: saas description

* fix: saas description

* Update docs/docs/concepts/policies.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* Update docs/docs/concepts/usecases/saas.md

Co-authored-by: mffap <mpa@caos.ch>

* docs: organisation --> organization

* docs: fixes

* docs: fixes

* Update docs/docs/apis/openidoauth/endpoints.md

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

* Update docs/docs/concepts/policies.md

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

* Update docs/docs/concepts/policies.md

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

* Update docs/docs/concepts/policies.md

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

* Update docs/docs/apis/openidoauth/endpoints.md

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

* Apply suggestions from code review

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

* docs: intro

* Update docs/docs/guides/customization/branding.md

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

* fix: typo

* add mermaid

Co-authored-by: Livio Amstutz <livio.a@gmail.com>
Co-authored-by: mffap <mpa@caos.ch>
Co-authored-by: Florian Forster <florian@caos.ch>
2021-09-23 10:34:06 +02:00

35 lines
869 B
Markdown

# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), 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
```console
yarn install
```
## Local Development
```console
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
```console
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.