Skip to content

Commit f269010

Browse files
authored
Update README.md
1 parent ee7e5c4 commit f269010

File tree

1 file changed

+7
-33
lines changed

1 file changed

+7
-33
lines changed

README.md

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,15 @@
11
# Website
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
44

5-
### Installation
5+
Pull Requests created to contribute towards BasisDocs will automatically kick off GitHub Actions to validate the files.
66

7-
```
8-
$ yarn
9-
```
7+
Merged content to the repository will automatically kick off GitHub Actions to publish the content to pages.
108

11-
### Local Development
9+
Published site can be found at https://docs.bassivr.org
1210

13-
```
14-
$ yarn start
15-
```
11+
### Contributing
1612

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.
13+
Currently we mainly use the docs and static directories to serve documentation with images
1814

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.
15+
You can find further information at https://docs.basisvr.org/docs/basisdocs-contrib

0 commit comments

Comments
 (0)