zitadel/site
Max Peintner 1e23292fc4
docs(images): reduce png sizes (#983)
* reduce png sizes

* chore: update some deps (#984)

* chore(deps): bump svelte-i18n from 3.1.0 to 3.2.5 in /site (#973)

Bumps [svelte-i18n](https://github.com/kaisermann/svelte-i18n) from 3.1.0 to 3.2.5.
- [Release notes](https://github.com/kaisermann/svelte-i18n/releases)
- [Changelog](https://github.com/kaisermann/svelte-i18n/blob/main/CHANGELOG.md)
- [Commits](https://github.com/kaisermann/svelte-i18n/compare/v3.1.0...v3.2.5)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump svelte from 3.29.4 to 3.29.7 in /site (#972)

Bumps [svelte](https://github.com/sveltejs/svelte) from 3.29.4 to 3.29.7.
- [Release notes](https://github.com/sveltejs/svelte/releases)
- [Changelog](https://github.com/sveltejs/svelte/blob/master/CHANGELOG.md)
- [Commits](https://github.com/sveltejs/svelte/compare/v3.29.4...v3.29.7)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump rollup from 2.33.1 to 2.33.2 in /site (#971)

Bumps [rollup](https://github.com/rollup/rollup) from 2.33.1 to 2.33.2.
- [Release notes](https://github.com/rollup/rollup/releases)
- [Changelog](https://github.com/rollup/rollup/blob/master/CHANGELOG.md)
- [Commits](https://github.com/rollup/rollup/compare/v2.33.1...v2.33.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump marked from 1.2.2 to 1.2.4 in /site (#970)

Bumps [marked](https://github.com/markedjs/marked) from 1.2.2 to 1.2.4.
- [Release notes](https://github.com/markedjs/marked/releases)
- [Changelog](https://github.com/markedjs/marked/blob/master/release.config.js)
- [Commits](https://github.com/markedjs/marked/compare/v1.2.2...v1.2.4)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps): bump sirv from 0.4.6 to 1.0.7 in /site (#969)

Bumps [sirv](https://github.com/lukeed/sirv) from 0.4.6 to 1.0.7.
- [Release notes](https://github.com/lukeed/sirv/releases)
- [Commits](https://github.com/lukeed/sirv/compare/v0.4.6...v1.0.7)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* chore(deps-dev): bump rollup-plugin-svelte from 6.1.0 to 6.1.1 in /site (#968)

Bumps [rollup-plugin-svelte](https://github.com/sveltejs/rollup-plugin-svelte) from 6.1.0 to 6.1.1.
- [Release notes](https://github.com/sveltejs/rollup-plugin-svelte/releases)
- [Changelog](https://github.com/sveltejs/rollup-plugin-svelte/blob/v6.1.1/CHANGELOG.md)
- [Commits](https://github.com/sveltejs/rollup-plugin-svelte/compare/v6.1.0...v6.1.1)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2020-11-18 16:11:47 +01:00
..
cypress feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
docs fix: add and verified projectID in audience (#957) 2020-11-16 10:54:48 +01:00
src docs(site): i18n handler, prettier code blocks and highlighting (#951) 2020-11-11 16:12:09 +01:00
static docs(images): reduce png sizes (#983) 2020-11-18 16:11:47 +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(images): reduce png sizes (#983) 2020-11-18 16:11:47 +01:00
package.json docs(images): reduce png sizes (#983) 2020-11-18 16:11:47 +01:00
README.md chore: spell check automation and spellcheck (#889) 2020-10-26 13:54:29 +01:00
rollup.config.js docs(site): downgrade sirv, commonjs plugin, preserve rollup signatures, minor seo tweak (#950) 2020-11-11 11:50:38 +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).