zitadel/docs
mffap 5b3f04e4d9
docs(self-hosting): add minimum system requirements (#6032)
* docs(self-hosting): add minimum system requirements

* Apply suggestions from code review

Co-authored-by: Florian Forster <florian@zitadel.com>

---------

Co-authored-by: Florian Forster <florian@zitadel.com>
2023-06-15 00:06:52 +02:00
..
docs docs(self-hosting): add minimum system requirements (#6032) 2023-06-15 00:06:52 +02:00
src docs: fix broken links (#5959) 2023-06-01 06:58:14 +02:00
static docs(concepts): Describe audit trail feature (#5747) 2023-05-04 15:37:28 +02:00
.gitignore docs(api): update api path (#5876) 2023-05-17 12:47:55 +00:00
babel.config.js docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
buf.gen.yaml docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
Dockerfile docs: improve api docs (#5158) 2023-02-23 18:08:06 +07:00
docusaurus.config.js docs(api): update api path (#5876) 2023-05-17 12:47:55 +00:00
nginx.conf docs(nginx): fix nginx directory, system api proto description (#5809) 2023-05-15 07:23:56 +00:00
package.json docs(playground): save to clipboard (#5488) 2023-03-22 07:19:19 +00:00
README.md docs: identity provider docs (#5565) 2023-04-12 09:42:40 +02:00
sidebars.js docs(legal): Account Lockout Policy (#5958) 2023-06-01 05:07:38 +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 docs(playground): save to clipboard (#5488) 2023-03-22 07:19:19 +00:00
yarn.lock docs(playground): save to clipboard (#5488) 2023-03-22 07:19:19 +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

yarn install

Generate

yarn generate

Local Development

yarn start

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