Skip to content

Commit bd98c13

Browse files
committed
docs: update example script
1 parent 914ae60 commit bd98c13

File tree

3 files changed

+471
-10
lines changed

3 files changed

+471
-10
lines changed

package.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"main": "src",
66
"scripts": {
77
"start": "rollup -c -w",
8+
"example": "serve",
89
"clean": "rimraf ./dist",
910
"prebuild": "run-s clean",
1011
"build": "run-s build:*",
@@ -54,6 +55,7 @@
5455
"rollup-plugin-node-builtins": "^2.1.2",
5556
"rollup-plugin-node-resolve": "^3.0.0",
5657
"rollup-plugin-postcss": "^1.5.1",
58+
"serve": "^13.0.2",
5759
"uglify-js": "^3.3.20"
5860
}
5961
}

readme.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,19 @@
6161
* **Description:** Router mode. In most cases, you don't need to modify it. Docsify-Pagination will take care of it for you.
6262

6363
## Example
64+
### Run example on local
65+
6466
- [Example](example/default/index.html)
6567
- [Example with Docsify's History Route-Mode](example/router-mode-history/index.html)
68+
69+
#### How to open these
70+
```bash
71+
$ yarn example
72+
```
73+
74+
### Online Showcase
6675
- [Tina.js](https://tina.js.org/)
76+
- [Tell us yours 😘](https://github.com/imyelo/docsify-pagination/edit/master/README.md)
6777

6878
## Related
6979
- [docsify](https://github.com/QingWei-Li/docsify/)

0 commit comments

Comments
 (0)