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
2021-05-16 23:51:45 +02:00
..
developer-docs Merge branch 'master' into openapi-v3 2021-05-16 23:51:45 +02:00
docs website/docs: improve wording on release notes, point to tag for docker-compose download 2021-05-16 23:08:11 +02:00
src *: replace swagger with openapi 2021-05-16 14:23:05 +02:00
static root: remove swagger 2021-05-16 23:24:52 +02: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
babel.config.js Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
docusaurus.config.js root: use ghcr images by default 2021-05-13 20:15:29 +02:00
package-lock.json build(deps): bump @docusaurus/preset-classic in /website (#872) 2021-05-13 11:18:39 +02:00
package.json build(deps): bump @docusaurus/preset-classic in /website (#872) 2021-05-13 11:18:39 +02:00
README.md Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
sidebars.js website/docs: add 2021.5 to sidebar 2021-05-08 16:42:46 +02:00
sidebarsDev.js website/docs-dev: add initial translation docs 2021-04-18 17:31:15 +02: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.