zitadel/docs/README.md
mffap 91081caf9f
docs: Add reference to Actions for custom claims and custom attributes (#7204)
* make clear that yarn generate has to be run first

* add reference to custom claims

* add reference to custom saml attribute
2024-01-11 15:27:37 +01:00

943 B

ZITADEL-Docs

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

Install dependencies with

yarn install

then run

yarn generate

Local Development

Start a local development server with

yarn start

When working on the API docs, run a local development server with

yarn start:api

Container Image

If you just want to start docusaurus locally without installing node you can fallback to our container image. Execute the following commands from the repository root to build and start a local version of ZITADEL

docker build -f docs/Dockerfile . -t zitadel-docs
docker run -p 8080:8080 zitadel-docs