mirror of
https://github.com/zitadel/zitadel.git
synced 2024-12-12 11:04:25 +00:00
18 lines
832 B
Markdown
18 lines
832 B
Markdown
|
## 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 `folder`[Folder](https://github.com/caos/site/tree/master/docs) located at root of the targeted repository.
|
||
|
|
|
||
|
|
## Running locally
|
||
|
|
|
||
|
|
Set up the project:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm i
|
||
|
|
```
|
||
|
|
|
||
|
|
Start the server with `npm run dev`, and navigate to [localhost:3000](http://localhost:3000).
|
||
|
|
|
||
|
|
### Honorable Mentions
|
||
|
|
|
||
|
|
This project was created with the help of some components from [svelte](https://github.com/sveltejs/svelte)([MIT](https://github.com/sveltejs/svelte/blob/master/LICENSE)) as well as [site-kit](https://github.com/sveltejs/site-kit)([MIT](https://github.com/sveltejs/site-kit/blob/master/LICENSE)).
|