History

leonnicolas 51f1ae94ef cmd/gen-docs/main.go: auto generate docs for CRD The new make command `make gen-docs` is introduced. It will build a markdown file from the CRD introduced by Kilo. The generation of the docs is a requirement for building the website. Signed-off-by: leonnicolas <leonloechner@gmx.de>		2021-05-17 13:54:56 +02:00
..
docs	cmd/gen-docs/main.go: auto generate docs for CRD	2021-05-17 13:54:56 +02:00
src	website/src: correct icon alignment	2020-03-10 12:57:20 +01:00
static/img	website/static: update favicon	2020-03-10 11:56:44 +01:00
.gitignore	docs: remove frontmatter	2020-03-10 00:47:25 +01:00
README.md	website: create website	2020-03-09 23:53:30 +01:00
docusaurus.config.js	website: update syntax for new docusaurus version	2020-09-17 13:05:47 +02:00
package.json	website/package.json: bump node_modules and update yarn.lock	2021-05-15 00:45:18 +02:00
sidebars.js	cmd/gen-docs/main.go: auto generate docs for CRD	2021-05-17 13:54:56 +02:00
yarn.lock	website/package.json: bump node_modules and update yarn.lock	2021-05-15 00:45:18 +02:00

Website

This website is built using Docusaurus 2, a modern static website generator.

$ yarn

$ yarn start

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.