finally added a readme
All checks were successful
build-docusaurus / build (push) Successful in 1m13s

This commit is contained in:
Jonas_Jones 2025-06-13 17:10:44 +02:00
parent 166ea604f4
commit 3456159f52

View file

@ -1,41 +1,3 @@
# Website
# Jonas_Jones Documentation
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
### Installation
```
$ yarn
```
### Local Development
```
$ yarn start
```
This command starts a local development server and opens 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
Using SSH:
```
$ USE_SSH=true yarn deploy
```
Not using SSH:
```
$ GIT_USER=<Your GitHub username> 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.
This is the repository for my Documentation at [docs.jonasjones.dev](https://docs.jonasjones.dev)