habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

website: cleanup readme

Browse Source 
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
Jens Langhammer
2022-09-18 18:45:05 +02:00
parent 9ab066a863
commit f008c03524
1 changed files with 4 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
website/README.md
View File

@ -1,17 +1,17 @@
# Website
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
## Installation
```console
yarn install
npm ci
```
## Local Development
```console
yarn watch
npm run 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.
@ -19,15 +19,7 @@ This command starts a local development server and open up a browser window. Mos
## Build
```console
yarn build
npm run 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.