History

jrandolf d011ca8616 docs: use algolia (#9208 ) This PR adds algolia search to the documentation.		2022-11-03 09:40:12 +01:00
..
src/css	docs: improve docs (#9179 )	2022-10-28 08:49:28 +02:00
static	chore: format docs (#8629 )	2022-07-05 15:41:43 +02:00
versioned_docs/version-19.2.1	chore: release main (#9184 )	2022-11-02 10:54:37 +01:00
versioned_sidebars	chore: release main (#9184 )	2022-11-02 10:54:37 +01:00
archive.js	chore: remove old website versions and point to md docs instead (#8757 )	2022-08-09 11:13:05 +00:00
babel.config.js	feat: add documentation (#8593 )	2022-07-01 11:52:39 +00:00
docusaurus.config.js	docs: use algolia (#9208 )	2022-11-03 09:40:12 +01:00
package-lock.json	docs: use algolia (#9208 )	2022-11-03 09:40:12 +01:00
package.json	docs: use algolia (#9208 )	2022-11-03 09:40:12 +01:00
README.md	feat: add documentation (#8593 )	2022-07-01 11:52:39 +00:00
sidebars.js	docs: improve docs (#9179 )	2022-10-28 08:49:28 +02:00
versions.json	chore: release main (#9184 )	2022-11-02 10:54:37 +01:00
versionsArchived.json	chore: release main (#9184 )	2022-11-02 10:54:37 +01:00

Website

This website is built using Docusaurus 2.

$ npm install

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

$ npm run build

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

Using SSH:

$ USE_SSH=true npm run deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> npm run 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.