zitadel/site
Max Peintner 1fc4034373
docs: searchable documentation & seo (#911)
* create search field

* search trigger, show field on interaction

* update deps, fix emitter

* crop out html, filtered search, i18h, layout

* i18n

* catch crtl f

* create combindes result store

* fix search query, remove store

* fixed search on side

* fix preload

* improve mobile layout, assets

* layout optimisations

* header

* doc nav bar, mobile, new dashboard

* toolbar

* fix modal

* z-index issue, header

* hl param

* fix lang switch, nav

* home, sub section, 18n, layout, assets

* develope, docs sublinks

* update home, mobile first

* fix language switcher

* add home seo

* fix flex search, dashboard

* seo embed, fix docs dropdown

* mouse navigation in search

* jsonld

* seo

* fix link

* rm section if none

* rm unused segment

* update lock

* remove combined slug

* Apply suggestions from code review

Co-authored-by: Florian Forster <florian@caos.ch>
2020-11-04 20:02:17 +01:00
..
cypress feat(documentation): svelte app as document generator (#566) 2020-08-11 09:53:09 +02:00
docs docs: searchable documentation & seo (#911) 2020-11-04 20:02:17 +01:00
src docs: searchable documentation & seo (#911) 2020-11-04 20:02:17 +01:00
static docs: searchable documentation & seo (#911) 2020-11-04 20:02:17 +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: searchable documentation & seo (#911) 2020-11-04 20:02:17 +01:00
package.json docs: searchable documentation & seo (#911) 2020-11-04 20:02:17 +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).