mirror of
https://github.com/zitadel/zitadel
synced 2024-11-22 18:44:40 +00:00
35 lines
867 B
Markdown
35 lines
867 B
Markdown
|
# Website
|
||
|
|
|
||
|
|
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), 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
|
||
|
|
|
||
|
|
```console
|
||
|
|
yarn install
|
||
|
|
```
|
||
|
|
|
||
|
|
## Local Development
|
||
|
|
|
||
|
|
```console
|
||
|
|
yarn start
|
||
|
|
```
|
||
|
|
|
||
|
|
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
|
||
|
|
|
||
|
|
## Build
|
||
|
|
|
||
|
|
```console
|
||
|
|
yarn build
|
||
|
|
```
|
||
|
|
|
||
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||
|
|
|
||
|
|
## Deployment
|
||
|
|
|
||
|
|
Each PR will be automaticly built with a preview link from cloudflare pages.
|
||
|
|
Visit the checks / comments on the PR for the link.
|