Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity
8a3889d570
unleash.unleash/website/README.md
Drew Gorton ebf35790fe
Update docs README.md to include yarn generate (#4519) 
Add missing `yarn generate` command to docs
2023-08-17 10:32:57 -05:00

868 B
Raw Blame History

Website

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

Installation

yarn install

Generate Open API docs

yarn generate

Generate the Open API docs that live at Reference documentation > APIs > OpenAPI

Local Development

yarn start

Start 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

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.