Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: add vuepress documentation #534

Merged
merged 108 commits into from Dec 3, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
786289e
Docs: add vuepress documentation
mysticatea Jul 25, 2018
7d2b646
small update for rule index
mysticatea Aug 2, 2018
f624ae9
add links to source code
mysticatea Aug 2, 2018
b5a2da4
Merge remote-tracking branch 'origin/master' into vuepress
mysticatea Aug 2, 2018
a429e6d
small tweaks
mysticatea Aug 2, 2018
f760b36
upgrade vuepress
mysticatea Aug 2, 2018
5a83e46
update eslint-code-block component
mysticatea Aug 4, 2018
f7a3056
update attribute-hyphenation
mysticatea Aug 4, 2018
2cd1959
update attributes-order
mysticatea Aug 4, 2018
2f451eb
update component-name-in-template-casing
mysticatea Aug 4, 2018
4a60998
update html-closing-bracket-newline
mysticatea Aug 4, 2018
b4f654b
update html-closing-bracket-spacing
mysticatea Aug 4, 2018
40de2a3
update html-end-tags
mysticatea Aug 4, 2018
c1a2d3d
update html-indent
mysticatea Aug 4, 2018
03f7c96
update html-quotes
mysticatea Aug 4, 2018
fe78932
update html-self-closing
mysticatea Aug 4, 2018
116eb34
update max-attributes-per-line
mysticatea Aug 4, 2018
53e01ff
add uncategorized rules to sidebar
mysticatea Aug 11, 2018
f6d7fb4
update mustache-interpolation-spacing
mysticatea Aug 11, 2018
dead35e
update name-property-casing
mysticatea Aug 11, 2018
af5e64d
update no-async-in-computed-properties
mysticatea Aug 11, 2018
8de5e5f
update no-confusing-v-for-v-if
mysticatea Aug 12, 2018
68bdf10
update no-dupe-keys
mysticatea Aug 12, 2018
8325289
update no-duplicate-attributes
mysticatea Aug 12, 2018
cf02d78
update no-multi-spaces
mysticatea Aug 12, 2018
aef46cf
update no-parsing-error
mysticatea Aug 14, 2018
4dcc6b9
update no-reserved-keys
mysticatea Aug 14, 2018
77356ee
update no-shared-component-data
mysticatea Aug 14, 2018
d1fb784
update no-side-effects-in-computed-properties
mysticatea Aug 14, 2018
54dabac
update no-template-key
mysticatea Aug 14, 2018
fea2c98
update no-template-shadow
mysticatea Aug 14, 2018
1f3770f
update no-textarea-mustache
mysticatea Aug 14, 2018
303d5b9
update no-unused-vars
mysticatea Aug 14, 2018
3b23e23
update no-use-v-if-with-v-for
mysticatea Aug 14, 2018
fdfeb76
update no-v-html
mysticatea Aug 14, 2018
5902957
update order-in-components
mysticatea Aug 14, 2018
ac27804
update prop-name-casing
mysticatea Aug 14, 2018
ba25f22
Add `valid-*` eslint-code-block (#622)
armano2 Nov 6, 2018
ac6bc3e
Merge branch 'master' into vuepress
armano2 Nov 9, 2018
1aaa5b8
Merge pull request #636 from armano2/vuepress-merge
michalsnik Nov 10, 2018
75093d9
Update documentation
armano2 Nov 12, 2018
029c14a
Change some of blockquotes to warnings
armano2 Nov 12, 2018
5dda9a0
require-prop-type-constructor
armano2 Nov 12, 2018
cf5ac56
add missing Implementation blocks
armano2 Nov 12, 2018
e421e2f
comment-directive
armano2 Nov 12, 2018
62ef6c3
Merge branch 'master' into vuepress
armano2 Nov 13, 2018
88abee4
require-render-return
armano2 Nov 12, 2018
b5c7379
jsx-uses-vars code type
armano2 Nov 12, 2018
eee4f2d
require-prop-type-constructor
armano2 Nov 12, 2018
bc44d69
update
armano2 Nov 13, 2018
dd84609
add missing options
armano2 Nov 13, 2018
6206cc9
Update
armano2 Nov 13, 2018
8cb6530
fix remaining missing options
armano2 Nov 13, 2018
1e07433
Update require-component-is & no-use-v-if-with-v-for
armano2 Nov 13, 2018
a4971b1
Update formating from html to vue
armano2 Nov 13, 2018
cb102eb
require-default-prop
armano2 Nov 13, 2018
212c547
Related links -> :books: Further reading
armano2 Nov 13, 2018
c88cf5a
standarize heading icons
armano2 Nov 13, 2018
8982d6b
Add processors
armano2 Nov 13, 2018
b36f7ed
no-multi-spaces after merge
armano2 Nov 13, 2018
e2830ef
improve consistency across docs
armano2 Nov 13, 2018
d788835
this-in-template
armano2 Nov 13, 2018
8fddc36
require-prop-types
armano2 Nov 13, 2018
ce33e7c
multiline-html-element-content-newline
armano2 Nov 13, 2018
e667635
fix json structure in return in computed property
armano2 Nov 13, 2018
55dff97
Add Further reading for few rules
armano2 Nov 13, 2018
81c106c
no-unused-components
armano2 Nov 13, 2018
dfb7e4e
Enable fixing eslint-code-block only one fixable rules
armano2 Nov 13, 2018
53e780a
Add deprecated category
armano2 Nov 13, 2018
22804af
Do not include cateogry in deprecated rules
armano2 Nov 13, 2018
9221c6f
Add example to return-in-computed-property
armano2 Nov 13, 2018
4ec403e
Add links and fix style
armano2 Nov 13, 2018
c20aa92
fix rebase issue no-multi-spaces
armano2 Nov 13, 2018
c21db98
Update description of require-v-for-key
armano2 Nov 14, 2018
7a0765e
Update docs/rules/require-render-return.md
armano2 Nov 14, 2018
09f688b
add moe notes
armano2 Nov 14, 2018
b7be87a
Improve readibility and add Further reading links
armano2 Nov 14, 2018
3ec1f2c
mustache-interpolation-spacing & name-property-casing
armano2 Nov 14, 2018
8529e66
Add IntelliJ IDEA / JetBrains WebStorm configuration help
armano2 Nov 14, 2018
6a652ee
Fix links
armano2 Nov 15, 2018
d6aa089
replace emoji with shortcodes
armano2 Nov 15, 2018
f82fc31
Add yarn install guide
armano2 Nov 15, 2018
504eeee
Fix issue with not supported `vue/comment-directive`
armano2 Nov 15, 2018
7332deb
unify options json (2 -> "error")
armano2 Nov 16, 2018
afd3232
Add bad example of no-use-v-vi-with-v-for
armano2 Nov 16, 2018
337db12
editor: update default formating to preset in documentation
armano2 Nov 16, 2018
de318eb
Merge branch 'master' into vuepress
armano2 Nov 18, 2018
17cc807
Merge branch 'master' into vuepress
armano2 Nov 23, 2018
8ef1367
Update vue-eslint-editor to fix tooltip issue
armano2 Nov 23, 2018
9afa0d4
Add comment about auto-generated content
michalsnik Nov 25, 2018
d16556f
Fix indentations in Vue file
michalsnik Nov 25, 2018
8bef2da
Add short description for vue/attribute-hyphenation rule
michalsnik Nov 25, 2018
a44f1bb
Add short description for vue/this-in-template rule
michalsnik Nov 26, 2018
2f8415a
Update valid-template-root docs
michalsnik Nov 26, 2018
7aa194c
Update user guide structure
michalsnik Nov 26, 2018
1936eed
Update rules heading in docs
michalsnik Nov 26, 2018
1dce58c
Flatten sidebar navigation for rules
michalsnik Nov 26, 2018
188ddcc
Merge branch 'master' into vuepress
michalsnik Nov 26, 2018
0fdc3b9
Update valid-template-root.md
michalsnik Nov 26, 2018
7a86e6d
Update README.md
michalsnik Nov 26, 2018
84b1238
Setup docs deployment
michalsnik Nov 26, 2018
ac990c2
Uncomment deploy.sh
michalsnik Nov 26, 2018
ba5f607
Add description metadata to rule pages & fix updating metadata when h…
armano2 Nov 26, 2018
7e81383
Indicate `no-parsing-error` warning as Note
armano2 Nov 27, 2018
3acc45c
Merge github.com:vuejs/eslint-plugin-vue into vuepress
michalsnik Dec 3, 2018
047c411
Ignore gh-pages in CircleCI
michalsnik Dec 3, 2018
aace2ba
Merge branch 'vuepress' of github.com:vuejs/eslint-plugin-vue into vu…
michalsnik Dec 3, 2018
53d1235
Fix CircleCI config
michalsnik Dec 3, 2018
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
27 changes: 20 additions & 7 deletions .circleci/config.yml
Expand Up @@ -6,6 +6,12 @@ workflows:
- node-v8
- node-v10
- node-v10-minimal
- deploy_docs:
requires:
- node-v10
filters:
branches:
only: master

version: 2
jobs:
Expand All @@ -20,19 +26,16 @@ jobs:
- restore_cache:
keys:
- v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
- v2-npm-lock-master-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
- v2-npm-cache-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}
- v2-npm-cache-master-{{ .Environment.CIRCLE_JOB }}
- run:
name: Install dependencies
command: npm install
- run:
name: Test
command: npm test
- save_cache:
key: v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
paths:
- node_modules
- run:
name: Test
command: npm test

node-v6:
<<: *node-base
Expand All @@ -46,6 +49,7 @@ jobs:
<<: *node-base
docker:
- image: node:10
working_directory: ~/node_10
node-v10-minimal:
steps:
- run:
Expand Down Expand Up @@ -73,4 +77,13 @@ jobs:
- node_modules
docker:
- image: node:10


deploy_docs:
docker:
- image: node:10
steps:
- attach_workspace:
at: ~/node_10
- run:
name: Deploy to Github Pages
command: npm run docs:deploy
armano2 marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 2 additions & 1 deletion package.json
Expand Up @@ -13,7 +13,8 @@
"version": "npm run lint -- --fix && git add .",
"update": "node ./tools/update.js",
"docs:watch": "vuepress dev docs",
"docs:build": "vuepress build docs"
"docs:build": "vuepress build docs",
"docs:deploy": "./tools/deploy.sh"
},
"files": [
"lib"
Expand Down
12 changes: 12 additions & 0 deletions tools/deploy.sh
@@ -0,0 +1,12 @@
#!/usr/bin/env sh

set -e
npm run docs:build
# cd docs/.vuepress/dist

# git init
# git add -A
# git commit -m 'deploy'
# git push -f git@github.com:vuejs/eslint-plugin-vue.git master:gh-pages

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think about using something like this instead:

https://github.com/eldarlabs/ghpages-deploy-script/blob/master/scripts/deploy-ghpages.sh

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the benefits of using it instead? I copied deploy script from the official Vuepress documentation :)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instead of making one commit and force pushing it over and over again, its adding changes only

cd -