LaconicNetwork/canine-docs
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

updating readme

Browse Source
This commit is contained in:
Marston Connell 2023-04-27 10:31:06 -04:00
parent 2443e6885c
commit 0b5cadb108
1 changed files with 1 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,6 +1,4 @@
# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
# Jackal Docs
### Installation
@ -24,18 +22,3 @@ $ 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.