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
99f45b4248
unleash.unleash/website
History
Thomas Heartman 99f45b4248
docs: Add front-end API setup to the quickstart guide (#2984) 
## What

This change adds instructions on how to use the front-end API for
client-side SDKs to the quickstart guide. It also organizes the content
so that this info is presented before the proxy info.

## Why

The front-end API is easier to use, so it should be preferred over the
proxy for people who are just getting started.
2023-01-25 12:11:23 +00:00
..
.storybook docs(docs): document the use of AliasPlugin for theme resolution 2022-04-02 16:47:38 +02:00
docs docs: Add front-end API setup to the quickstart guide (#2984) 2023-01-25 12:11:23 +00:00
src docs: auto-generate remaining server-side SDK docs (#2858) 2023-01-13 12:40:28 +01:00
static docs: service accounts (#2881) 2023-01-13 09:46:50 +00: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 docs: add link to the Unleash help center (#2926) 2023-01-18 13:59:43 +01:00
package.json fix(deps): update dependency docusaurus-theme-openapi-docs to v1.5.1 (#2934) 2023-01-19 21:24:28 +00:00
readme-fns.js docs: auto-generate remaining server-side SDK docs (#2858) 2023-01-13 12:40:28 +01:00
README.md fix: rename websitev2 to website 2021-10-26 11:25:19 +02:00
sidebars.js docs: auto-generate remaining server-side SDK docs (#2858) 2023-01-13 12:40:28 +01:00
tsconfig.json chore: convert feedback component to typescript 2022-03-02 10:50:46 +01:00
yarn.lock chore(deps): bump cookiejar from 2.1.3 to 2.1.4 in /website (#2977) 2023-01-24 14:24:12 +01: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.