mirror of
https://github.com/zitadel/zitadel
synced 2024-11-22 08:49:13 +00:00
86c124955d
# Which Problems Are Solved - `<details>` tag is rendered in some cases in the docs, instead of rendering a detail section which can be expanded - New API V2 and V3 services where not rendered correctly - The plugin which made it possible to integrate external code files and show them on the docs didn't work anymore # How the Problems Are Solved - remove / from details tag, so it is properly rendered - changing link source from tag to auto - Someone already forked the repository and made it available for docusaurus v3, we integrated the forked version --------- Co-authored-by: Stefan Benz <46600784+stebenz@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| apis/assets | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| buf.gen.yaml | ||
| docusaurus.config.js | ||
| frameworks.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tailwind.config.js | ||
| vercel.json | ||
| yarn.lock | ||
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