oauth2-proxy/docs
Jan Larwig 6c2c115d30
docs: upgrade to docusaurus 3.1.0 (#2388)
* initial commit for docusaurus 3 upgrade

* fix mdx errors

* fix mdx issues

* fix routing issues

* update docs generation workflow

* fix version

* fix permissions

* move slack to header

* remove background color and minify

* Add suggestions

* add shell to code blocks
2024-01-26 12:07:01 +00:00
..
docs docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
src/css docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
static docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
versioned_docs docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
versioned_sidebars docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
.gitignore Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
README.md feat: Added renovate configuration (#2377) 2024-01-20 19:51:34 +00:00
babel.config.js Migrate existing documentation to Docusaurus 2020-11-05 15:36:27 +00:00
docusaurus.config.js docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
package-lock.json docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
package.json docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
sidebars.js docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00
versions.json docs: upgrade to docusaurus 3.1.0 (#2388) 2024-01-26 12:07:01 +00:00

README.md

Website

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

Installation

npm install

Local Development

npm 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

npm 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 npm 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.