mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00

History

Thomas Heartman 44db4fb0c3 1-1360: explain implicit ^ and $ in docs (#4668 ) Update docs to explain that ^ and $ are implicit in the regexes used.		2023-09-12 14:23:19 +02:00
..
.storybook
docs	1-1360: explain implicit ^ and $ in docs (#4668 )	2023-09-12 14:23:19 +02:00
remote-content
src	feat: expose kapi as part of docs (#3996 )	2023-06-23 13:55:59 +02:00
static	docs: feature flag naming patterns (#4632 )	2023-09-11 15:28:10 +02:00
.gitignore
babel.config.js
clean-generated-docs.js
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	chore(deps): update react-router monorepo to v6.15.0 (#4532 )	2023-08-17 18:52:04 +00:00
README.md	Integrations - frontend adjustments (#4527 )	2023-08-22 14:40:38 +02:00
sidebars.js	docs: feature flag naming patterns (#4632 )	2023-09-11 15:28:10 +02:00
tsconfig.json
yarn.lock	chore(deps): update react-router monorepo to v6.15.0 (#4532 )	2023-08-17 18:52:04 +00: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.