mirror of https://github.com/Unleash/unleash.git synced 2025-01-11 00:08:30 +01:00

History

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
..
.storybook	docs(docs): document the use of AliasPlugin for theme resolution	2022-04-02 16:47:38 +02:00
docs	Update quickstart.md (#4474 )	2023-08-16 15:57:02 +02:00
remote-content	docs: remove "under construction" message for edge (#3351 )	2023-03-21 08:36:38 +01:00
src	feat: expose kapi as part of docs (#3996 )	2023-06-23 13:55:59 +02:00
static	feat: change request reject docs and step update (#4493 )	2023-08-16 09:46:05 +02:00
.gitignore	Docs/public signup (#2070 )	2022-10-10 16:12:11 +03:00
babel.config.js
clean-generated-docs.js	chore: update docusaurus/openapi integration to stable version (#2414 )	2022-11-14 08:52:46 +01:00
docusaurus.config.js	chore: add reo to docs	2023-07-07 12:52:46 +02:00
global.js	fix: do not include rio server-side	2023-07-07 14:08:50 +02:00
package.json	fix(deps): update dependency @svgr/webpack to v8 (#4407 )	2023-08-16 08:31:27 +02:00
README.md	Update docs README.md to include `yarn generate` (#4519 )	2023-08-17 10:32:57 -05:00
sidebars.js	docs: custom root roles (#4451 )	2023-08-10 08:21:58 +01:00
tsconfig.json	chore: convert feedback component to typescript	2022-03-02 10:50:46 +01:00
yarn.lock	chore(deps): update dependency browserslist to v4.21.10 (#4501 )	2023-08-16 09:08:29 +02:00

Website

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

Installation

yarn install

yarn generate

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

yarn start

Start a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

yarn build

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

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.