Skip to content

Commit 168eb26

Browse files
kiakingkiaking
committed
Install VuePress for docs
1 parent a4049a4 commit 168eb26

File tree

11 files changed

+5539
-72
lines changed

11 files changed

+5539
-72
lines changed

‎.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1+
/coverage
2+
/docs/.vuepress/dist
3+
/docs/node_modules
4+
/lib
15
/node_modules
26
yarn-error.log
3-
vuex-orm-axios*.tgz
4-
coverage

‎README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,12 +29,23 @@ User.api().get('/api/users')
2929

3030
Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community :two_hearts:
3131

32+
### Super Love Sponsors
33+
3234
<a href="https://github.com/petertoth">
3335
<img src="https://avatars2.githubusercontent.com/u/3661783?s=400&v=4" alt="Peter Tóth" width="96">
3436
</a>
3537
<a href="https://github.com/phaust">
3638
<img src="https://avatars1.githubusercontent.com/u/2367770?s=400&v=4" alt="Mario Kolli" width="96">
3739
</a>
40+
<a href="https://github.com/cannikan">
41+
<img src="https://avatars2.githubusercontent.com/u/21893904?s=460&v=4" alt="Cannikan" width="96">
42+
</a>
43+
44+
#### A Love Sponsors
45+
46+
<a href="https://github.com/georgechaduneli">
47+
<img src="https://avatars1.githubusercontent.com/u/9340753?s=460&v=4" alt="George Chaduneli" width="64">
48+
</a>
3849

3950
## Documentation
4051

‎docs/.vuepress/config.js

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
const sidebars = {
2+
guide: [
3+
{
4+
title: 'Guide',
5+
collapsable: false,
6+
children: [
7+
'/guide/installation',
8+
'/guide/sponsors'
9+
]
10+
},
11+
],
12+
13+
api: [
14+
{
15+
title: 'API',
16+
collapsable: false,
17+
children: [
18+
'/api/model'
19+
]
20+
}
21+
]
22+
}
23+
24+
module.exports = {
25+
title: 'Vuex ORM Axios',
26+
description: 'Vuex ORM persistence plugin to sync the store against a RESTful API.',
27+
28+
base: '/vuex-orm-axios/',
29+
30+
themeConfig: {
31+
repo: 'vuex-orm/plugin-axios',
32+
docsDir: 'docs',
33+
34+
nav: [
35+
{
36+
text: 'Guide',
37+
link: '/guide/'
38+
},
39+
{
40+
text: 'API Reference',
41+
link: '/api/model'
42+
},
43+
{
44+
text: 'Release Notes',
45+
link: 'https://github.com/vuex-orm/plugin-axios/releases'
46+
}
47+
],
48+
49+
sidebar: {
50+
'/guide/': sidebars.guide,
51+
'/api/': sidebars.api,
52+
'/': sidebars.guide
53+
}
54+
}
55+
}

‎docs/README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Vuex Orm Plugin: Axios
2+
3+
Vuex ORM Axios plugin adds the smooth integration between API request call and Vuex ORM persistent through awesome [Axios](https://github.com/axios/axios).
4+
5+
## Sponsors
6+
7+
Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community :two_hearts:
8+
9+
### Super Love Sponsors
10+
11+
<br>
12+
13+
<a href="https://github.com/petertoth">
14+
<img src="https://avatars2.githubusercontent.com/u/3661783?s=400&v=4" alt="Peter Tóth" width="96" style="border-radius: 8px;">
15+
</a>
16+
<a href="https://github.com/phaust">
17+
<img src="https://avatars1.githubusercontent.com/u/2367770?s=400&v=4" alt="Mario Kolli" width="96" style="border-radius: 8px;">
18+
</a>
19+
<a href="https://github.com/cannikan">
20+
<img src="https://avatars2.githubusercontent.com/u/21893904?s=460&v=4" alt="Cannikan" width="96" style="border-radius: 8px;">
21+
</a>
22+
23+
### A Love Sponsors
24+
25+
<br>
26+
27+
<a href="https://github.com/georgechaduneli">
28+
<img src="https://avatars1.githubusercontent.com/u/9340753?s=460&v=4" alt="George Chaduneli" width="64" style="border-radius: 8px;">
29+
</a>
30+
31+
## Table Of Contents
32+
33+
- Guide
34+
- [Installation](guide/installation)
35+
- [Sponsors](guide/sponsors)
36+
- API
37+
- [Model](/api/model)
38+
39+
## Questions & Discussions
40+
41+
Join us on our [Slack Channel](https://join.slack.com/t/vuex-orm/shared_invite/enQtNDQ0NjE3NTgyOTY2LTc1YTI2N2FjMGRlNGNmMzBkMGZlMmYxOTgzYzkzZDM2OTQ3OGExZDRkN2FmMGQ1MGJlOWM1NjU0MmRiN2VhYzQ) for any questions and discussions.
42+
43+
Although there is the Slack Channel, do not hesitate to open an [issue](https://github.com/vuex-orm/vuex-orm/issues) for any question you might have. We're always more than happy to hear any feedback, and we don't care what kind of form they are.
44+
45+
## Plugins
46+
47+
Vuex ORM can be extended via a plugin to add additional features. Here is the list of available plugins.
48+
49+
- [Vuex ORM GraphQL](https://github.com/vuex-orm/plugin-graphql) – The plugin to sync the store against a [GraphQL](https://graphql.org) API.
50+
- [Vuex ORM Search](https://github.com/vuex-orm/plugin-search) – The plugin adds a search() method to filter records using fuzzy search logic from the [Fuse.js](http://fusejs.io).
51+
- [Vuex ORM Change Flags](https://github.com/vuex-orm/plugin-change-flags) - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.
52+
- [Vuex ORM Soft Delete](https://github.com/vuex-orm/plugin-soft-delete) – Vuex ORM plugin for adding soft delete feature to model entities.
53+
54+
## Resources
55+
56+
- [Vue](https://vuejs.org)
57+
- [Vuex](https://vuex.vuejs.org)
58+
- [Vuex ORM](https://vuex-orm.github.io/vuex-orm/)
59+
60+
You may find a list of awesome things related to Vuex ORM at [Awesome Vuex ORM](https://github.com/vuex-orm/awesome-vuex-orm).

‎docs/api/model.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
sidebarDepth: 2
3+
---
4+
5+
# Model
6+
7+
Coming soon...

‎docs/deploy.sh

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/usr/bin/env sh
2+
3+
set -e
4+
5+
npm run docs:build
6+
7+
cd docs/.vuepress/dist
8+
9+
git init
10+
git add -A
11+
git commit -m 'deploy'
12+
13+
git push -f [email protected]:vuex-orm/plugin-axios.git master:gh-pages
14+
15+
cd -

‎docs/guide/README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Vuex Orm Plugin: Axios
2+
3+
Vuex ORM Axios plugin adds the smooth integration between API request call and Vuex ORM persistent through awesome [Axios](https://github.com/axios/axios).
4+
5+
## Sponsors
6+
7+
Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community :two_hearts:
8+
9+
### Super Love Sponsors
10+
11+
<br>
12+
13+
<a href="https://github.com/petertoth">
14+
<img src="https://avatars2.githubusercontent.com/u/3661783?s=400&v=4" alt="Peter Tóth" width="96" style="border-radius: 8px;">
15+
</a>
16+
<a href="https://github.com/phaust">
17+
<img src="https://avatars1.githubusercontent.com/u/2367770?s=400&v=4" alt="Mario Kolli" width="96" style="border-radius: 8px;">
18+
</a>
19+
<a href="https://github.com/cannikan">
20+
<img src="https://avatars2.githubusercontent.com/u/21893904?s=460&v=4" alt="Cannikan" width="96" style="border-radius: 8px;">
21+
</a>
22+
23+
### A Love Sponsors
24+
25+
<br>
26+
27+
<a href="https://github.com/georgechaduneli">
28+
<img src="https://avatars1.githubusercontent.com/u/9340753?s=460&v=4" alt="George Chaduneli" width="64" style="border-radius: 8px;">
29+
</a>
30+
31+
## Table Of Contents
32+
33+
- Guide
34+
- [Installation](guide/installation)
35+
- [Sponsors](guide/sponsors)
36+
- API
37+
- [Model](/api/model)
38+
39+
## Questions & Discussions
40+
41+
Join us on our [Slack Channel](https://join.slack.com/t/vuex-orm/shared_invite/enQtNDQ0NjE3NTgyOTY2LTc1YTI2N2FjMGRlNGNmMzBkMGZlMmYxOTgzYzkzZDM2OTQ3OGExZDRkN2FmMGQ1MGJlOWM1NjU0MmRiN2VhYzQ) for any questions and discussions.
42+
43+
Although there is the Slack Channel, do not hesitate to open an [issue](https://github.com/vuex-orm/vuex-orm/issues) for any question you might have. We're always more than happy to hear any feedback, and we don't care what kind of form they are.
44+
45+
## Plugins
46+
47+
Vuex ORM can be extended via a plugin to add additional features. Here is the list of available plugins.
48+
49+
- [Vuex ORM GraphQL](https://github.com/vuex-orm/plugin-graphql) – The plugin to sync the store against a [GraphQL](https://graphql.org) API.
50+
- [Vuex ORM Search](https://github.com/vuex-orm/plugin-search) – The plugin adds a search() method to filter records using fuzzy search logic from the [Fuse.js](http://fusejs.io).
51+
- [Vuex ORM Change Flags](https://github.com/vuex-orm/plugin-change-flags) - Vuex ORM plugin for adding IsDirty / IsNew flags to model entities.
52+
- [Vuex ORM Soft Delete](https://github.com/vuex-orm/plugin-soft-delete) – Vuex ORM plugin for adding soft delete feature to model entities.
53+
54+
## Resources
55+
56+
- [Vue](https://vuejs.org)
57+
- [Vuex](https://vuex.vuejs.org)
58+
- [Vuex ORM](https://vuex-orm.github.io/vuex-orm/)
59+
60+
You may find a list of awesome things related to Vuex ORM at [Awesome Vuex ORM](https://github.com/vuex-orm/awesome-vuex-orm).

‎docs/guide/installation.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Installation
2+
3+
You can install Vuex ORM Axios via NPM, Yarn, or download it directly. Remember since Vuex ORM Axios is a plugin of [Vuex ORM](https://github.com/vuex-orm/vuex-orm), you need to install Vuex ORM and Vuex alongside with Vuex ORM Axios.
4+
5+
## NPM
6+
7+
```console
8+
$ npm install vue vuex @vuex-orm/core @vuex-orm/plugin-axios --save
9+
```
10+
11+
## Yarn
12+
13+
```console
14+
$ yarn add vue vuex @vuex-orm/core @vuex-orm/plugin-axios
15+
```
16+
17+
## Direct Download / CDN
18+
19+
[https://unpkg.com/@vuex-orm/plugin-axios](https://unpkg.com/@vuex-orm/plugin-axios)
20+
21+
[Unpkg.com](https://unpkg.com) provides NPM-based CDN links. The above link always points to the latest release on NPM. You can also use a specific version/tag via URLs like `https://unpkg.com/@vuex-orm/plugin-axios`.
22+
23+
Include Vuex ORM Axios from an HTML script.
24+
25+
```html
26+
<script src="https://unpkg.com/@vuex-orm/plugin-axios"></script>
27+
28+
<!-- For the minified version -->
29+
<script src="https://unpkg.com/@vuex-orm/plugin-axios/dist/vuex-orm.min.js"></script>
30+
```
31+
32+
## Dev Build
33+
34+
You have to clone directly from GitHub and build vuex yourself if you want to use the latest dev build.
35+
36+
```console
37+
$ git clone https://github.com/vuex-orm/plugin-axios.git node_modules/@vuex-orm/plugin-axios
38+
$ cd node_modules/@vuex-orm/plugin-axios
39+
$ npm install
40+
$ npm run build
41+
```

‎docs/guide/sponsors.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Sponsors
2+
3+
Vuex ORM is sponsored by awesome folks. Big love to all of them from whole Vuex ORM community :two_hearts:
4+
5+
### Super Love Sponsors
6+
7+
<br>
8+
9+
<a href="https://github.com/petertoth">
10+
<img src="https://avatars2.githubusercontent.com/u/3661783?s=400&v=4" alt="Peter Tóth" width="96" style="border-radius: 8px;">
11+
</a>
12+
<a href="https://github.com/phaust">
13+
<img src="https://avatars1.githubusercontent.com/u/2367770?s=400&v=4" alt="Mario Kolli" width="96" style="border-radius: 8px;">
14+
</a>
15+
<a href="https://github.com/cannikan">
16+
<img src="https://avatars2.githubusercontent.com/u/21893904?s=460&v=4" alt="Cannikan" width="96" style="border-radius: 8px;">
17+
</a>
18+
19+
### A Love Sponsors
20+
21+
<br>
22+
23+
<a href="https://github.com/georgechaduneli">
24+
<img src="https://avatars1.githubusercontent.com/u/9340753?s=460&v=4" alt="George Chaduneli" width="64" style="border-radius: 8px;">
25+
</a>

‎package.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@
1818
"test": "jest",
1919
"test:watch": "jest --watchAll",
2020
"coverage": "jest --collect-coverage",
21-
"clean": "rm -rf dist && rm -rf lib && rm -rf coverage && rm -rf .nyc_output && rm -rf .tmp"
21+
"clean": "rm -rf dist && rm -rf lib && rm -rf coverage && rm -rf .nyc_output && rm -rf .tmp",
22+
"docs": "vuepress dev docs",
23+
"docs:build": "vuepress build docs",
24+
"docs:deploy": "bash ./docs/deploy.sh"
2225
},
2326
"repository": {
2427
"type": "git",
@@ -55,6 +58,8 @@
5558
"typescript": "^3.5.3",
5659
"uglify-js": "^3.6.0",
5760
"vue": "^2.6.10",
61+
"vuepress": "^1.2.0",
62+
"vuepress-theme-vue": "^1.1.0",
5863
"vuex": "^3.1.1"
5964
},
6065
"jest": {

0 commit comments

Comments
 (0)