docs/README.md · typeable/oauth2-proxy

git.iko.soy/typeable/oauth2-proxy

on reference-generator help sign in

33 lines 745 B history raw

1# Website

3This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.

5## Installation

7```console

8yarn install

9```

11## Local Development

13```console

14yarn start

15```

17This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

19## Build

21```console

22yarn build

23```

25This command generates static content into the `build` directory and can be served using any static contents hosting service.

27## Deployment

29```console

30GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

31```

33If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.