mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-11 00:08:30 +01:00
29da625195
## What This PR updates the version of the docusaurus-openapi plugin we depend on for openapi docs generation from canary version 0.0.0-514 to stable release 1.4.4. Also removes the manual file cleanup that was created as a workaround to solve the issues we were having. ## Why When we set the canary version before the weekend it was because it contained a fix of some of the issues we were having with our docs. That issue (and the one about file cleanup) have now been released in v1.4.4, so we can upgrade to a stable version and remove now-redundant cleanup code. |
||
|---|---|---|
| .. | ||
| .storybook | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| babel.config.js | ||
| clean-generated-docs.js | ||
| docusaurus.config.js | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
| tsconfig.json | ||
| yarn.lock | ||
Website
This website is built using Docusaurus 2, a modern static website generator.
Installation
yarn install
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
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.