Skip to content

Commit 609a43d

Browse files
committedFeb 14, 2025
update readme
1 parent baa1bda commit 609a43d

File tree

1 file changed

+4
-26
lines changed

1 file changed

+4
-26
lines changed
 

‎README.md

+4-26
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,19 @@
1-
# Website
1+
# drawDB documentation
22

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4-
5-
### Installation
6-
7-
```
8-
$ yarn
9-
```
3+
Documentation website for drawDB that addresses frequestly asked questions built using [Docusaurus](https://docusaurus.io/).
104

115
### Local Development
126

137
```
14-
$ yarn start
8+
$ npm start
159
```
1610

1711
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
1812

1913
### Build
2014

2115
```
22-
$ yarn build
16+
$ npm build
2317
```
2418

2519
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.

0 commit comments

Comments
 (0)