zitadel/site
Max Peintner d71eb25dbc
fix(docs): rehaul styling (#893)
* fix: adapt styling to marketing, console

* side icon margin
2020-10-22 17:09:08 +02:00
..
cypress feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
docs chore(documentation): documentation and manuals for ZITADEL (#710) 2020-10-16 14:13:02 +02:00
src fix(docs): rehaul styling (#893) 2020-10-22 17:09:08 +02:00
static fix(docs): rehaul styling (#893) 2020-10-22 17:09:08 +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
CONTRIBUTING.md chore(documentation): documentation and manuals for ZITADEL (#710) 2020-10-16 14:13:02 +02:00
cypress.json feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
package-lock.json chore(deps-dev): bump rollup-plugin-svelte from 5.2.2 to 6.0.1 in /site (#852) 2020-10-16 17:11:59 +02:00
package.json chore(deps-dev): bump rollup-plugin-svelte from 5.2.2 to 6.0.1 in /site (#852) 2020-10-16 17:11:59 +02:00
README.md chore(documentation): documentation and manuals for ZITADEL (#710) 2020-10-16 14:13:02 +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 documentation 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).