2020-05-05 21:19:57 +02:00
|
|
|
# Website
|
|
|
|
|
|
|
|
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
|
|
|
|
2021-02-18 14:17:39 +01:00
|
|
|
## Installation
|
2020-05-05 21:19:57 +02:00
|
|
|
|
2021-02-18 14:17:39 +01:00
|
|
|
```bash
|
|
|
|
npm install
|
2020-05-05 21:19:57 +02:00
|
|
|
```
|
|
|
|
|
2021-02-18 14:17:39 +01:00
|
|
|
## Local Development
|
2020-05-05 21:19:57 +02:00
|
|
|
|
2021-02-18 14:17:39 +01:00
|
|
|
```bash
|
|
|
|
npm run start
|
2020-05-05 21:19:57 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
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
|
|
|
|
|
2021-02-18 14:17:39 +01:00
|
|
|
```bash
|
|
|
|
npm run build
|
2020-05-05 21:19:57 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
|
|
|
|
### Deployment
|
|
|
|
|
2021-02-18 14:17:39 +01:00
|
|
|
```bash
|
|
|
|
GIT_USER=<Your GitHub username> USE_SSH=true npm run deploy
|
2020-05-05 21:19:57 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
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.
|