This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.

History

Jens Langhammer b81e2e69d1 website/docs: prepare 2021.10.1-rc2 Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>		2021-10-21 16:49:11 +02:00
..
developer-docs	website/docs: add missing make migrate	2021-10-11 22:33:31 +02:00
docs	website/docs: prepare 2021.10.1-rc2	2021-10-21 16:49:11 +02:00
help	root: fix linting errors	2021-07-18 20:54:34 +02:00
netlify/functions	website: remove .git suffix for go import	2021-10-18 17:48:13 +02:00
src	website: remove sentry	2021-09-18 14:33:53 +02:00
static	website/docs: add symlink for latest compose	2021-10-13 17:51:54 +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	root: use custom url for discord	2021-10-21 10:40:43 +02:00
docusaurus.docs-only.js	root: use custom url for discord	2021-10-21 10:40:43 +02:00
netlify.toml	website: add redirect for discord	2021-10-21 10:37:53 +02:00
package-lock.json	build(deps): bump postcss from 8.3.9 to 8.3.10 in /website (#1652 )	2021-10-21 10:29:48 +02:00
package.json	build(deps): bump postcss from 8.3.9 to 8.3.10 in /website (#1652 )	2021-10-21 10:29:48 +02:00
sidebars.js	core: add user flag to prevent users from changing their usernames	2021-10-20 16:17:19 +02:00
sidebarsDev.js	website/docs: fix sidebar	2021-10-11 22:45:24 +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.