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

History

Thomas Heartman 6b5e25b191 Docs(fix): broken links (#2797 ) This change fixes some broken links in the "about the docs" document. Most of these links go to concrete documents and have been replaced with their appropriate relative file links. The few links that go to auto-generated pages have been corrected. Unfortunately, there does not seem to be an easy way to link safely to generated pages.		2023-01-03 11:27:45 +01:00
..
.storybook
docs	Docs(fix): broken links (#2797 )	2023-01-03 11:27:45 +01:00
src	docs: add "The Anatomy of Unleash" (#2138 )	2022-10-19 13:14:49 +02:00
static	Docs/change request beta docs (#2608 )	2022-12-06 14:02:44 +01: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: remove constraints announcements from readme and docs (#2678 )	2023-01-03 10:11:04 +01:00
package.json	fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.0 (#2763 )	2022-12-29 00:04:18 +00:00
README.md
sidebars.js	Docs/change request beta docs (#2608 )	2022-12-06 14:02:44 +01:00
tsconfig.json
yarn.lock	fix(deps): update dependency docusaurus-plugin-openapi-docs to v1.5.0 (#2763 )	2022-12-29 00:04:18 +00:00

Website

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

Installation

yarn install

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.

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.