TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2024-12-12 02:54:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
e8db038839
zitadel/site/README.md
Florian Forster 9f0638fac9
chore: spell check automation and spellcheck (#889) 
* test spell check

* fix indenting

* test

* add something to test

* test spellcheck

* spelling improvements

* improve spelling and ignore list

* Update site/docs/start/00-quick-start.de.md
2020-10-26 13:54:29 +01:00

834 B
Raw Blame History

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