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/README.md
Issy Szemeti 9ab066a863
website: Fix padding in feature comparison table (#3611)
* Fix table block styling

* Add correct command to run development server

* Update website/src/css/custom.css

closes #3315

Co-authored-by: Jens L. <jens@beryju.org>
Signed-off-by: Issy Szemeti <48881813+issy@users.noreply.github.com>

Signed-off-by: Issy Szemeti <48881813+issy@users.noreply.github.com>
Co-authored-by: Jens L. <jens@beryju.org>
2022-09-18 16:43:05 +00:00

34 lines
745 B
Markdown

# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
```
## Local Development
```console
yarn watch
```
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
```console
yarn build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
## Deployment
```console
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.