zitadel/docs
Silvan f8b711ca5c
docs(actions): correct actions examples (#8350)
# Which Problems Are Solved

The docs currently link to the wrong trigger.

# How the Problems Are Solved

Changed the links.
2024-07-23 15:45:11 +02:00
..
apis/assets ci: improve performance (#5953) 2023-07-17 10:08:20 +02:00
docs docs(actions): correct actions examples (#8350) 2024-07-23 15:45:11 +02:00
src docs: add video to quickstart (#7512) 2024-03-06 18:31:49 +00:00
static feat(console): replace secret generator dialogs with cards (#8307) 2024-07-18 05:33:10 +00:00
.gitignore chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
babel.config.js chore(docs): use gh action to build docs (#8097) 2024-06-13 08:07:39 +00:00
buf.gen.yaml chore(api): initial definition of API for user schemas (user v3 and user schema v3 service) (#7372) 2024-02-15 11:22:48 +01:00
docusaurus.config.js fix: multiple docs issues (#8244) 2024-07-11 07:54:04 +02:00
frameworks.json docs: add pylon framework to examples (#8115) 2024-06-17 07:37:07 +00:00
package.json fix: multiple docs issues (#8244) 2024-07-11 07:54:04 +02:00
README.md docs: Add reference to Actions for custom claims and custom attributes (#7204) 2024-01-11 15:27:37 +01:00
sidebars.js docs: Add the SAML intro docs (#8112) 2024-07-08 11:11:09 +00:00
tailwind.config.js docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707) 2022-12-05 18:36:12 +01:00
vercel.json chore(docs): Migrate from Docusaurus v2 to v3 (#8036) 2024-06-20 12:55:03 +00:00
yarn.lock fix: multiple docs issues (#8244) 2024-07-11 07:54:04 +02:00

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