You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-11Lines changed: 13 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,25 +3,27 @@ Website for mo · js with tutorials and documentation.
3
3
4
4

5
5
6
-
## To get started
6
+
## Get started
7
7
* 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
9
9
10
10
## Deploy
11
11
* 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
14
14
15
15
## 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.
17
17
18
18
### 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.
20
20
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:
0 commit comments