deblan-mirror/buzz
1
0
Fork 0
mirror of https://github.com/chidiwilliams/buzz.git synced 2024-05-20 17:46:33 +02:00
Code Issues Packages Projects Releases Wiki Activity
buzz/docs
History
Chidi Williams 2567d7f65b Update docs
2023-10-29 16:22:08 +00:00
..
docs Update docs 2023-10-29 16:22:08 +00:00
src Add docs (#500) 2023-06-20 14:12:18 +00:00
static Add docs (#500) 2023-06-20 14:12:18 +00:00
.gitignore Add docs (#500) 2023-06-20 14:12:18 +00:00
babel.config.js Add docs (#500) 2023-06-20 14:12:18 +00:00
docusaurus.config.js Add docs (#500) 2023-06-20 14:12:18 +00:00
package-lock.json Add docs (#500) 2023-06-20 14:12:18 +00:00
package.json Add docs (#500) 2023-06-20 14:12:18 +00:00
README.md Add docs (#500) 2023-06-20 14:12:18 +00:00
sidebars.js Add docs (#500) 2023-06-20 14:12:18 +00:00
tsconfig.json Add docs (#500) 2023-06-20 14:12:18 +00:00

README.md

Website

This website is built using Docusaurus 2, 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.