-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add relevant information to docs readme
- Loading branch information
1 parent
97edef7
commit 56c040f
Showing
1 changed file
with
13 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,31 @@ | ||
# Website | ||
# Pretendo Docker Documentation | ||
|
||
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator. | ||
|
||
### Installation | ||
## [View the live site here](https://matthewl246.github.io/pretendo-docker) | ||
|
||
``` | ||
$ yarn | ||
``` | ||
## Development | ||
|
||
### Local Development | ||
### Install dependencies | ||
|
||
``` | ||
$ yarn start | ||
$ npm install | ||
``` | ||
|
||
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 | ||
### Start a local development server | ||
|
||
``` | ||
$ yarn build | ||
$ npm start | ||
``` | ||
|
||
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 | ||
``` | ||
This command starts a local development server and opens up a browser window. Most changes are reflected live without | ||
having to restart the server. | ||
|
||
Not using SSH: | ||
### Build the site | ||
|
||
``` | ||
$ GIT_USER=<Your GitHub username> yarn deploy | ||
$ npm run build | ||
``` | ||
|
||
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 command generates static content into the `build` directory and can be served using any static contents hosting | ||
service. |