mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00

History

Thomas Heartman 9448461aaa docs: prep to add OpenAPI spec to Unleash docs (#1907 ) * Docs: start experimenting with OpenAPI and docusaurus * Docs: add docusaurus-theme-openapi-docs pkg * Wip: current status * Docs: Add 'docusaurus-plugin-api-docs' * Move openapi into own sidebar; generate from localhost * Chore: Update docusaurus plugin for OpenAPI * Add website/yarn.lock to git * Fix: fix CSS warning by using flex-end instead of end * docs: make openapi generated code work again * docs: make tags work properly with openapi sidebar * Docs/chore: update OpenAPI tag scheme. Add a whole bunch of new tags to make it easier to understand available tags in OpenAPI. * docs: point to new openapi docs from old api docs * docs: typo * Docs: link restructure * docs: add operation indicators to openapi docs * docs: change badge color for operations * docs: update openapi-docs package It now sorts tags the same as the schema * docs: pluralize APIs in slug * docs: update links to generated api docs * docs: update openapi snapshot tests with new tags * docs: conditionally load spec from localhost or from file * docs: Remove changes relating to immediate switchover * refactor: rename types; extract into separate file * docs: fix api doc links		2022-08-12 11:37:57 +02:00
..
.storybook	docs(docs): document the use of AliasPlugin for theme resolution	2022-04-02 16:47:38 +02:00
docs	docs: prep to add OpenAPI spec to Unleash docs (#1907 )	2022-08-12 11:37:57 +02:00
src	docs: prep to add OpenAPI spec to Unleash docs (#1907 )	2022-08-12 11:37:57 +02:00
static	docs: update group docs with new screenshots and requirements for users (#1910 )	2022-08-11 14:01:32 +02:00
.gitignore	fix: rename websitev2 to website	2021-10-26 11:25:19 +02:00
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: prep to add OpenAPI spec to Unleash docs (#1907 )	2022-08-12 11:37:57 +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.