zitadel/docs
Fabi a065ddc706
docs: Make Examples and SDK Pages easier to understand (#7291)
* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: first attempt to restructure the sdks and examples to make it better understandable

* docs: adding more example pages

* docs: adding more example pages

* docs: add all sdk/examples

* docs: add tile component

* docs: introduction page

* docs: introduction page

* docs: add react

* docs: remove old sdk and example pages

* docs: fix broken links

* docs: fix broken links

* styles

* Update docs/docs/sdk-examples/introduction.mdx

Co-authored-by: Livio Spring <livio.a@gmail.com>

* Update docs/docs/sdk-examples/java.mdx

Co-authored-by: Livio Spring <livio.a@gmail.com>

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Livio Spring <livio.a@gmail.com>

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Livio Spring <livio.a@gmail.com>

* docs: review changes

* docs: smaller tiles

* docs: changes from go and java review

* docs: correct python description

* Update docs/docs/sdk-examples/python.mdx

Co-authored-by: Livio Spring <livio.a@gmail.com>

* Update docs/docs/sdk-examples/introduction.mdx

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

* Update docs/docs/sdk-examples/python.mdx

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

* docs: flask logo

* flask, rust imgs

* docs: flask logo

* Update go.mdx

* Update java.mdx

* Update docs/docs/sdk-examples/flutter.mdx

Co-authored-by: Livio Spring <livio.a@gmail.com>

* Update docs/src/css/tile.module.css

Co-authored-by: Livio Spring <livio.a@gmail.com>

* docs: sidebar alphabetic

* docs: sidebar alphabetic

* docs: django logo

---------

Co-authored-by: peintnermax <max@caos.ch>
Co-authored-by: Livio Spring <livio.a@gmail.com>
Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>
Co-authored-by: Stefan Benz <stefan@caos.ch>
2024-02-07 12:44:20 +01:00
..
apis/assets ci: improve performance (#5953) 2023-07-17 10:08:20 +02:00
docs docs: Make Examples and SDK Pages easier to understand (#7291) 2024-02-07 12:44:20 +01:00
src docs: Make Examples and SDK Pages easier to understand (#7291) 2024-02-07 12:44:20 +01:00
static docs: Make Examples and SDK Pages easier to understand (#7291) 2024-02-07 12:44:20 +01:00
.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 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: logo jumps to home page (#7329) 2024-02-06 14:52:45 +00: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: Make Examples and SDK Pages easier to understand (#7291) 2024-02-07 12:44:20 +01: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: redirect api path (#6232) 2023-07-19 00:15:41 +02:00
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