History

Jens Langhammer 36e6d5e394 website/docs: fix image reference typo Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>		2021-08-15 21:39:24 +02:00
..
developer-docs	website/developer-docs: simplify .env file	2021-08-15 18:13:25 +02:00
docs	website/docs: fix image reference typo	2021-08-15 21:39:24 +02:00
help	root: fix linting errors	2021-07-18 20:54:34 +02:00
src	website: add sentry	2021-07-19 21:50:56 +02:00
static	website: fix typo in example flow	2021-08-12 17:16:39 +02:00
.gitignore	root: build bundled docs into helo dir to fix path issue with packaged static files	2021-07-13 19:09:16 +02:00
.prettierignore	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
.prettierrc.json	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
README.md	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
babel.config.js	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01:00
docusaurus.config.js	website: add sentry	2021-07-19 21:50:56 +02:00
docusaurus.docs-only.js	root: add bundled docs	2021-07-13 11:06:51 +02:00
package-lock.json	build(deps): bump @sentry/tracing from 6.10.0 to 6.11.0 in /website (#1238 )	2021-08-09 09:53:16 +02:00
package.json	build(deps): bump @sentry/tracing from 6.10.0 to 6.11.0 in /website (#1238 )	2021-08-09 09:53:16 +02:00
sidebars.js	website/docs: Add Portainer to Integrations Providers docs (#1256 )	2021-08-15 20:58:52 +02:00
sidebarsDev.js	website/docs: add developer docs for frontend-only	2021-06-21 21:25:56 +02:00
static.go	root: build bundled docs into helo dir to fix path issue with packaged static files	2021-07-13 19:09:16 +02:00

README.md

Website

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

Installation

yarn install

Local Development

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.

Build

yarn build

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

Deployment

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.