mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-12 11:04:25 +00:00
|
|
||
|---|---|---|
| .. | ||
| cypress | ||
| docs | ||
| quickstarts | ||
| src | ||
| static | ||
| .gitignore | ||
| appveyor.yml | ||
| config.js | ||
| CONTRIBUTING.md | ||
| cypress.json | ||
| docker-compose.yml | ||
| dockerfile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| rollup.config.js | ||
Getting started
CAOS Site is a github action that generates a static page out of markdown files. It uses marked.js in combination with highlight.js to compile and style markdown.
The documentation is built according to the structure of a docs folderFolder located at root of the targeted repository.
Running locally
You can simply run the static site by using the docker-compose command below.
COMPOSE_DOCKER_CLI_BUILD=1 DOCKER_BUILDKIT=1 docker-compose -f site/docker-compose.yml up --build
Building locally
You can simply run the static site by using the docker-compose command below.
DOCKER_BUILDKIT=1 docker build -f site/dockerfile . -t zitadel:docs -o docs
Honorable Mentions
This project was created with the help of some components from svelte(MIT) as well as site-kit(MIT).