zitadel/docs
Fabi 0542b29517
docs: Contribution guidelines (#7443)
* docs: gender neutrality

* docs: gender neutrality

* docs: gender neutrality

* Update docs/docs/concepts/features/identity-brokering.md

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

* Update docs/docs/guides/integrate/login-ui/mfa.mdx

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

* Update docs/docs/guides/integrate/login-ui/passkey.mdx

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

* Update internal/static/i18n/en.yaml

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

* Update internal/static/i18n/en.yaml

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

---------

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>
2024-02-26 13:11:09 +00:00
..
apis/assets ci: improve performance (#5953) 2023-07-17 10:08:20 +02:00
docs docs: Contribution guidelines (#7443) 2024-02-26 13:11:09 +00:00
src docs: Make Examples and SDK Pages easier to understand (#7291) 2024-02-07 12:44:20 +01:00
static docs(integrate): Update login users docs (#7414) 2024-02-26 13:04:09 +05:30
.gitignore docs: copy config options to docs (#6143) 2023-08-07 22:32:10 +02:00
babel.config.js docs: improve api docs (#5158) 2023-02-23 18:08:06 +07: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
Dockerfile docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
docusaurus.config.js 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
nginx.conf docs(nginx): fix nginx directory, system api proto description (#5809) 2023-05-15 07:23:56 +00:00
package.json chore(npm): dependencies (#7141) 2024-01-08 10:25:21 +00: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(integrate): Update login users docs (#7414) 2024-02-26 13:04:09 +05:30
tailwind.config.js docs: add tailwindcss for styles, oidc authorize endpoint playground (#4707) 2022-12-05 18:36:12 +01:00
vercel.json docs(integrate): Update login users docs (#7414) 2024-02-26 13:04:09 +05:30
yarn.lock chore(npm): dependencies (#7141) 2024-01-08 10:25:21 +00: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