zitadel/site
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
..
cypress feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
docs chore: spell check automation and spellcheck (#889) 2020-10-26 13:54:29 +01:00
src docs: image gallery viewer (#905) 2020-10-26 13:03:51 +01:00
static docs: image gallery viewer (#905) 2020-10-26 13:03:51 +01: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 docs: image gallery viewer (#905) 2020-10-26 13:03:51 +01:00
package.json docs: image gallery viewer (#905) 2020-10-26 13:03:51 +01:00
README.md chore: spell check automation and spellcheck (#889) 2020-10-26 13:54:29 +01:00
rollup.config.js docs: image gallery viewer (#905) 2020-10-26 13:03:51 +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

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