1
0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
unleash.unleash/website
Thomas Heartman a3585343e1
docs: Move user groups section to after permissions section (#2081)
The permissions section is a subsection of the CPR section and
shouldn't be separated. This seems to have been an oversight.
2022-09-23 11:15:15 +02:00
..
.storybook docs(docs): document the use of AliasPlugin for theme resolution 2022-04-02 16:47:38 +02:00
docs docs: Move user groups section to after permissions section (#2081) 2022-09-23 11:15:15 +02:00
src Add OpenAPI docs (#1391) (#2066) 2022-09-19 14:50:24 +02:00
static Docs: update API access for new token type (#1958) 2022-09-15 09:02:10 +02:00
.gitignore Add OpenAPI docs (#1391) (#2066) 2022-09-19 14:50:24 +02:00
babel.config.js
clean-generated-docs.js Fix(#1391): fix edge case URLs in code samples (#2078) 2022-09-21 11:24:25 +02:00
docusaurus.config.js #1391: add generated doc cleaning script (#2077) 2022-09-20 12:43:39 +02:00
package.json #1391: add generated doc cleaning script (#2077) 2022-09-20 12:43:39 +02:00
README.md fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00
sidebars.js Add OpenAPI docs (#1391) (#2066) 2022-09-19 14:50:24 +02:00
tsconfig.json chore: convert feedback component to typescript 2022-03-02 10:50:46 +01:00
yarn.lock #1391: add generated doc cleaning script (#2077) 2022-09-20 12:43:39 +02:00

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.