toastie_t0ast/Toastie-Blog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Updated README.md

Browse source
This commit is contained in:
Toastie 2023-12-09 01:24:37 +13:00
parent 6efc34c601
commit febcb36479
No known key found for this signature in database
GPG key ID: FF47E5D4A3C8DC5E
1 changed files with 2 additions and 40 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -1,41 +1,3 @@
# Website # Toastie's blog
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. The code responsible for making the blog at https://blog.toastiet0ast.com work
### 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.