Florian Forster cf54239f51
feat(docs): quickstart, clients and projects (#864)
* init screenshots

* Improve Users

* add screenshots

* start guide & clent & project improvements

* minor corrections to links

* minor typos
2020-10-22 17:12:59 +02:00
..
2020-10-22 17:09:08 +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).