mirror of
https://github.com/zitadel/zitadel.git
synced 2025-07-16 21:28:36 +00:00
4b7443ba78
This pull request enhances the documentation site configuration by introducing a new plugin and making minor adjustments to existing settings. The primary focus is on integrating the `@signalwire/docusaurus-plugin-llms-txt` plugin to improve content handling and adding relevant dependencies. ### Plugin Integration: * [`docs/docusaurus.config.js`](diffhunk://#diff-28742c737e523f302e6de471b7fc27284dc8cf720be639e6afe4c17a550cd654R245-R255): Added the `@signalwire/docusaurus-plugin-llms-txt` plugin with configuration options, including a depth of 3, log level of 1, exclusion of certain routes, and enabling markdown file support. * [`docs/package.json`](diffhunk://#diff-adfa337ce44dc2902621da20152a048dac41878cf3716dfc4cc56d03aa212a56R33): Included the `@signalwire/docusaurus-plugin-llms-txt` dependency (version `^1.2.0`) to support the new plugin integration. ### Configuration Adjustments: * [`docs/docusaurus.config.js`](diffhunk://#diff-28742c737e523f302e6de471b7fc27284dc8cf720be639e6afe4c17a550cd654L221): Removed the `docItemComponent` property under the `module.exports` configuration.
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.
If you are introducing new APIs (gRPC), you need to add a new entry to docusaurus.config.js under the plugins section.
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