zitadel/docs/README.md
Florian Forster 311df70a3f
docs: allow privacy friendly analytics in docs page and set hsts (#3006)
* chore: prepare deployment to netlify instead of cloudflare

* add badge
2022-01-18 09:04:48 +01:00

37 lines
1.0 KiB
Markdown

[![Netlify Status](https://api.netlify.com/api/v1/badges/b82a23f7-d8c7-4025-af18-a46586e89ed0/deploy-status)](https://app.netlify.com/sites/zitadel-docs/deploys)
# 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 automatically built with a preview link from cloudflare pages.
Visit the checks / comments on the PR for the link.