Go to file
Simon Vieille 039a924976
ci/woodpecker/push/woodpecker Pipeline was successful Details
update changelog
2024-02-20 23:51:25 +01:00
bin replace mkdocs with docusaurus 2024-01-23 23:46:17 +01:00
docs update changelog 2024-02-20 23:51:25 +01:00
src fix typo 2024-01-23 23:56:18 +01:00
static update configuration 2024-01-25 17:38:09 +01:00
.gitignore update configuration 2024-01-25 17:46:57 +01:00
.woodpecker.yml update configuration 2024-01-25 17:46:57 +01:00
Makefile update changelog generator 2024-01-16 21:29:05 +01:00
README.md replace mkdocs with docusaurus 2024-01-23 23:46:17 +01:00
babel.config.js replace mkdocs with docusaurus 2024-01-23 23:46:17 +01:00
docusaurus.config.js (debug) update configuration 2024-01-25 17:44:05 +01:00
package-lock.json replace mkdocs with docusaurus 2024-01-23 23:46:17 +01:00
package.json update configuration 2024-01-25 17:46:57 +01:00
sidebars.js replace mkdocs with docusaurus 2024-01-23 23:46:17 +01:00

README.md

Website

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

Installation

$ yarn

Local Development

$ yarn 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.

Build

$ yarn build

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

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

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