Skip to content

Commit 0dcb80c

Browse files
committed
scaffold docs
1 parent 9fc0ee9 commit 0dcb80c

File tree

5 files changed

+46
-1
lines changed

5 files changed

+46
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ coverage
44
explorations
55
TODOS.md
66
*.log
7+
docs/_book

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
- HTML5 history mode or hash mode, with auto-fallback in IE9
1616
- Restore scroll position when going back in history mode
1717

18-
Get started with the [documentation](http://vuejs.github.io/vue-router).
18+
Get started with the [documentation](http://vuejs.github.io/vue-router) (WIP).
1919

2020
### Development Setup
2121

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

docs/SUMMARY.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Summary
2+
3+
- [Installation](installation.md)
4+
- [Basic Usage](basic.md)
5+
- [Router Options](options.md)
6+
- [Top Level API](api/README.md)
7+
- [router.map](api/map.md)
8+
- [router.on](api/on.md)
9+
- [router.redirect](api/redirect.md)
10+
- [router.alias](api/alias.md)
11+
- [router.beforeEach](api/before-each.md)
12+
- [router.go](api/go.md)
13+
- [router.replace](api/replace.md)
14+
- [router.start](api/start.md)
15+
- [router.stop](api/stop.md)
16+
- [View Lifecycle Configuration](config/README.md)
17+
- [data](config/data.md)
18+
- [activate](config/activate.md)
19+
- [deactivate](config/deactivate.md)
20+
- [canActivate](config/can-activate.md)
21+
- [canDeactivate](config/can-deactivate.md)
22+
- [canReuse](config/can-reuse.md)

docs/installation.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Installation
2+
3+
### Direct Download
4+
5+
See [dist folder](https://github.com/vuejs/vue-router/tree/dev/dist). Note the dist files are always the latest stable - it's not update-to-date with the `dev` branch source.
6+
7+
### NPM
8+
9+
``` bash
10+
npm install vue-router
11+
# dev branch
12+
npm install vuejs/vue-router#dev
13+
```
14+
15+
### Bower
16+
17+
``` bash
18+
bower install vue-router
19+
# dev branch
20+
bower install vuejs/vue-router#dev
21+
```

0 commit comments

Comments
 (0)