1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2024-11-28 09:08:44 +02:00
oauth2-proxy/docs
2021-09-27 14:37:19 -04:00
..
docs Fix formatting of Keycloak provider documentation 2021-09-27 14:37:19 -04:00
src Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
static Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
versioned_docs Provide a link to the Helm chart for oauth2-proxy (#1217) 2021-06-09 15:03:51 +01:00
versioned_sidebars Created versioned docs for v7.1.x 2021-03-25 17:21:08 +00:00
.gitignore Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
babel.config.js Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
docusaurus.config.js Add version dropdown to docs header 2020-11-08 19:37:46 +00:00
package-lock.json Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
package.json Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
README.md Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
sidebars.js Deprecate GAP-Signature and add a warning on usage (#1103) 2021-03-14 09:47:44 -07:00
versions.json Created versioned docs for v7.1.x 2021-03-25 17:21:08 +00: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 open 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.