This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website
Jens Langhammer b81f3e4a38 docs: prepare next release 2021-01-16 22:38:46 +01:00
..
docs docs: prepare next release 2021-01-16 22:38:46 +01:00
src docs: add grafana integration docs 2020-12-29 20:43:27 +01:00
static root: global email settings (#448) 2021-01-05 00:41:10 +01:00
.gitignore Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
.prettierignore Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
.prettierrc.json Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
README.md Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
babel.config.js Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
docusaurus.config.js docs: fix issues when overscrolling 2020-12-14 14:16:00 +01:00
package-lock.json Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
package.json Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
sidebars.js docs: prepare next release 2021-01-16 22:38:46 +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 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.