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 L 7be680cbe5
Migrate to Docusaurus (#329)
* docs: initial migration to docusaurus

* website: add custom font, update blurbs and icons

* website: update splash

* root: update links to docs

* flows: use .pbflow extension so docusaurus doesn't mangle the files

* e2e: workaround prospector

* Squashed commit of the following:

commit 1248585dca
Author: Jens Langhammer <jens.langhammer@beryju.org>
Date:   Sun Nov 15 20:46:53 2020 +0100

    e2e: attempt to fix prospector error again

commit 1319c480c4
Author: Jens Langhammer <jens.langhammer@beryju.org>
Date:   Sun Nov 15 20:41:35 2020 +0100

    ci: install previous python version for upgrade testing

* web: update accent colours and format

* website: format markdown files

* website: fix colours for text

* website: switch to temporary accent colour to improve readability

* flows: fix path for TestTransferDocs

* flows: fix formatting of tests
2020-11-15 22:42:02 +01:00
..
docs Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
src Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
static Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +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 Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +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 Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +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.