Skip to content

Commit 5b01c4f

Browse files
author
andrewstech
authored
Merge pull request #1 from PeerBrain/andrewstech-patch-1
Update README.md
2 parents 5e9bfaa + 6bc0508 commit 5b01c4f

File tree

1 file changed

+2
-40
lines changed

1 file changed

+2
-40
lines changed

README.md

+2-40
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,3 @@
1-
# Website
1+
# DOCS SITE
22

3-
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
4-
5-
### Installation
6-
7-
```
8-
$ yarn
9-
```
10-
11-
### Local Development
12-
13-
```
14-
$ yarn start
15-
```
16-
17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18-
19-
### Build
20-
21-
```
22-
$ yarn build
23-
```
24-
25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
26-
27-
### Deployment
28-
29-
Using SSH:
30-
31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
34-
35-
Not using SSH:
36-
37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
40-
41-
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.
3+
Changes must be made via PR not direct.

0 commit comments

Comments
 (0)