side_menu_doc/README.md
Simon Vieille 8e23bd78df
Some checks failed
ci/woodpecker/push/woodpecker Pipeline failed
replace mkdocs with docusaurus
2024-01-23 23:46:17 +01:00

768 B

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.