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 a074ea70e9 website/docs-dev: add initial translation docs Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>		2021-04-18 17:31:15 +02:00
..
developer-docs	website/docs-dev: add initial translation docs	2021-04-18 17:31:15 +02:00
docs	website: separate development docs	2021-04-18 17:25:58 +02:00
src	website: add API Browser	2021-04-18 17:15:19 +02:00
static	website: add API Browser	2021-04-18 17:15:19 +02:00
.gitignore	Migrate to Docusaurus (#329 )	2020-11-15 22:42:02 +01: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: separate development docs	2021-04-18 17:25:58 +02:00
package-lock.json	website: add API Browser	2021-04-18 17:15:19 +02:00
package.json	website: add API Browser	2021-04-18 17:15:19 +02:00
sidebars.js	website: separate development docs	2021-04-18 17:25:58 +02:00
sidebarsDev.js	website/docs-dev: add initial translation docs	2021-04-18 17:31:15 +02:00

Website

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

Installation

yarn install

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.