dependabot[bot] bcf47a82c6
chore(deps): bump marked from 1.2.7 to 2.0.0 in /site (#1263)
Bumps [marked](https://github.com/markedjs/marked) from 1.2.7 to 2.0.0.
- [Release notes](https://github.com/markedjs/marked/releases)
- [Changelog](https://github.com/markedjs/marked/blob/master/release.config.js)
- [Commits](https://github.com/markedjs/marked/compare/v1.2.7...v2.0.0)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2021-02-19 09:05:30 +01:00
..

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).