zitadel/site
Max Peintner 2c517d6278
feat(documentation): svelte app as document generator (#566)
* check in full site application

* rm unused assets components

* change base css

* i18n

* new doc workflow

* fix crosslink to doc in github

* nav, console link, assets, console brand

* edit configjs server

* rm go struct references

* cleanup input output bindings

* working dir

* export path

* always trigger

* rel paths

* cname

* rev workdir

* fix fallbacklanguage, home on large screens

* remove mit from site
2020-08-11 09:53:09 +02:00
..
cypress feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
docs/get_started feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
src feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
static feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +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
cypress.json feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
package-lock.json feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
package.json feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
README.md feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +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 documentiation 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).