History

Lucas Servén Marín 0cc1a2ff8c docs,website: add doc for kg This commit adds a doc for `kg`, the Kilo agent that runs on every node in the mesh. This includes: the doc itself, files needed for the website, and tooling to generate the document using `embedmd`. Signed-off-by: Lucas Servén Marín <lserven@gmail.com>		2020-09-23 11:38:25 +02:00
..
docs	docs,website: add doc for kg	2020-09-23 11:38:25 +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: add dependency resolutions	2020-09-17 14:28:07 +02:00
sidebars.js	docs,website: add doc for kg	2020-09-23 11:38:25 +02:00
yarn.lock	website: add dependency resolutions	2020-09-17 14:28:07 +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.