Skip to content

Commit ca3d560

Browse files
Fix typos
1 parent 4234c96 commit ca3d560

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,27 @@ Website for mo · js with tutorials and documentation.
33

44
![mo · js](logo.png "mo · js")
55

6-
## To get started
6+
## Get started
77
* Run `npm i` to install all dependencies
8-
* Run `npm start` to start the project on `http://localhost:8080`
8+
* Run `npm run dev` to run the projet locally at `http://localhost:8080`, your browser will open the URL automatically
99

1010
## Deploy
1111
* Run `npm run build`
12-
* Try the build using `npx serve docs/.vuepress/dist`
13-
* Push to the mojs.github.io master branch using `. deploy.sh`
12+
* Try the build locally using `npx serve docs/.vuepress/dist`
13+
* Automatic deployment through Github Actions on the `master` branch
1414

1515
## Tips for docs writers
16-
If you need very special demo that doesn't work with the `<MojsCode>`or the `MojsInteractive` components, create a new component and add it to the folder "components". Make shure the name doen't contain a number, VuePress doesn't like that.
16+
If you need very special demo that doesn't work with the `<MojsCode>` or the `MojsInteractive` components, create a new one and add it to the "components" folder. Make sure the name doesn't contain a number, VuePress doesn't like that.
1717

1818
### Known bugs
19-
* If you get a `Unknown custom element:` or any other wierd errors, try restarting VuePress by stopping the process in tour terminal and run `npm run start` again to clear the VuePress cache. It's probably due to some JS error in a custom component that you used wrote.
19+
* If you get an `Unknown custom element` or any other weird errors, try restarting VuePress by stopping the process in your terminal, then run `npm run dev` again to clear the VuePress cache. It's probably due to some JS error in a custom component that you used to wrote.
2020

21-
* If you get an `Errors compiling template: tag <p> has no matching end tag.`, make sure you have a dubble line break before any html comments (`<!--`). Like this:
21+
* If you get an `Errors compiling template: tag <p> has no matching end tag.` error, make sure you have a double line break before any HTML comments (`<!--`), like this:
2222

23-
```md
24-
My code
23+
```md
24+
My code
2525

26-
<!-- Some html comment -->
27-
```
26+
<!-- Some html comment -->
27+
```
28+
29+
Happy coding with `mojs` :tada

0 commit comments

Comments
 (0)