History

Jan Larwig 53cd0b83d3 add contribution guide to documentation (#2318 ) * add contribution guide to doucmentation * fix EOF		2023-11-13 10:27:28 +00:00
..
docs	add contribution guide to documentation (#2318 )	2023-11-13 10:27:28 +00:00
src	add contribution guide to documentation (#2318 )	2023-11-13 10:27:28 +00:00
static	add contribution guide to documentation (#2318 )	2023-11-13 10:27:28 +00:00
versioned_docs	add contribution guide to documentation (#2318 )	2023-11-13 10:27:28 +00:00
versioned_sidebars	add contribution guide to documentation (#2318 )	2023-11-13 10:27:28 +00:00
.gitignore	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
README.md	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
babel.config.js	Migrate existing documentation to Docusaurus	2020-11-05 15:36:27 +00:00
docusaurus.config.js	Refactored docs (#2284 )	2023-10-31 19:32:59 +00:00
package-lock.json	Refactored docs (#2284 )	2023-10-31 19:32:59 +00:00
package.json	Refactored docs (#2284 )	2023-10-31 19:32:59 +00:00
sidebars.js	add contribution guide to documentation (#2318 )	2023-11-13 10:27:28 +00:00
versions.json	Create versioned docs for release v7.5.x	2023-09-04 12:28:42 +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.