zitadel/site
Max Peintner 77575110bb
docs: new zitadel logo assets, img height in readme (#612)
* fix: zitadel logo, header padding in docs

* zitadel logo height

* Update README.md

* Update README.md

* use png

* smaller

* Update README.md

* Update README.md

* Update README.md

* Update README.md
2020-08-20 22:18:53 +02:00
..
cypress feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
docs/get_started feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
src docs: new zitadel logo assets, img height in readme (#612) 2020-08-20 22:18:53 +02:00
static docs: new zitadel logo assets, img height in readme (#612) 2020-08-20 22:18:53 +02:00
.gitignore feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
appveyor.yml feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
config.js feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
cypress.json feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
package-lock.json feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
package.json feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
README.md feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
rollup.config.js feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02: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 documentiation is built according to the structure of a docs folderFolder located at root of the targeted repository.

Running locally

Set up the project:

npm i

Start the server with npm run dev, and navigate to localhost:3000.

Honorable Mentions

This project was created with the help of some components from svelte(MIT) as well as site-kit(MIT).