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
bf11001d1c
unleash.unleash/website
History
Thomas Heartman 6516ac21ee
docs(#1873): Document the Unleash playground (#1901) 
* Docs: start adding stuff for the playground docs

* docs(#1873): start filling in playground doc

* docs(#1873): draft 1

* docs(#1873): add playground images

* docs(#1873): typo (pr comment)

* docs(#1873): Add a sentence or two about stickiness

* docs(#1873): merge required and implicit fields

* docs(#1873): reduce cognitive complexity

* docs(#1873): add link to stickiness calculation section

* docs(#1873): add detailed results image

* docs(#1873): reword playground requirement env and proj
2022-08-12 12:17:25 +02:00
..
.storybook
docs docs(#1873): Document the Unleash playground (#1901) 2022-08-12 12:17:25 +02:00
src docs: prep to add OpenAPI spec to Unleash docs (#1907) 2022-08-12 11:37:57 +02:00
static docs(#1873): Document the Unleash playground (#1901) 2022-08-12 12:17:25 +02:00
.gitignore
babel.config.js
docusaurus.config.js docs: prep to add OpenAPI spec to Unleash docs (#1907) 2022-08-12 11:37:57 +02:00
package.json docs: prep to add OpenAPI spec to Unleash docs (#1907) 2022-08-12 11:37:57 +02:00
README.md
sidebars.js docs(#1873): Document the Unleash playground (#1901) 2022-08-12 12:17:25 +02:00
tsconfig.json
yarn.lock docs: prep to add OpenAPI spec to Unleash docs (#1907) 2022-08-12 11:37:57 +02:00

README.md

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.