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 be5c8341d2 root: add bundled docs
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
2021-07-13 11:06:51 +02:00
..
developer-docs website/docs: add instruction for local.env.yml for frontend dev 2021-06-22 12:06:55 +02:00
docs website/docs: add note about logging out 2021-07-06 14:26:11 +02:00
src website: clear up comparison 2021-06-16 14:54:44 +02:00
static stages/user_write: add create_users_as_inactive flag 2021-06-28 23:24:54 +02:00
.gitignore root: add bundled docs 2021-07-13 11:06:51 +02: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 website: fix duplicate plugin ID 2021-06-12 20:15:35 +02:00
docusaurus.docs-only.js root: add bundled docs 2021-07-13 11:06:51 +02:00
package-lock.json root: add bundled docs 2021-07-13 11:06:51 +02:00
package.json root: add bundled docs 2021-07-13 11:06:51 +02:00
sidebars.js Break down Sources into individual sections in Docs (#1052) 2021-06-22 21:46:44 +02:00
sidebarsDev.js website/docs: add developer docs for frontend-only 2021-06-21 21:25:56 +02:00
static.go root: add bundled docs 2021-07-13 11:06:51 +02: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.