Skip to content

docs: Plugin development guide #2973

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

Merged
merged 89 commits into from
Jan 25, 2019
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
89 commits
Select commit Hold shift + click to select a range
90bcf15
feat(docs): add Heroku deployment section
NataliaTepluhina Sep 16, 2018
d3e9b39
fix: rename remote repository section title
NataliaTepluhina Sep 17, 2018
d3c889a
fix(docs): add a middleware for handling vue-router in deployed app
NataliaTepluhina Oct 7, 2018
e23a308
fix(docs): fixed formatting
NataliaTepluhina Oct 7, 2018
24d71bd
Merge branch 'dev' of github.com:vuejs/vue-cli into dev
NataliaTepluhina Nov 8, 2018
de9ac04
feat: Create structure for Plugin and Generator API; create Getting s…
NataliaTepluhina Nov 11, 2018
8ac991d
feat: started registerCommand description
NataliaTepluhina Nov 11, 2018
9e4f149
feat: Add a description for adding new vue-cli-service command
NataliaTepluhina Nov 13, 2018
e0fef0b
fix: Change the part about modifying existing vue-cli-service commands
NataliaTepluhina Nov 13, 2018
3ae7146
Merge branch 'dev' of github.com:vuejs/vue-cli into dev
NataliaTepluhina Nov 15, 2018
2b7495a
feat: Add local installation steps for cli-plugin with/without Vue UI
NataliaTepluhina Nov 17, 2018
2a0f544
feat: Add generator extending package and changing main file chapters
NataliaTepluhina Nov 17, 2018
273782f
feat: Create structure for Plugin and Generator API; create Getting s…
NataliaTepluhina Nov 11, 2018
eca99f4
feat: started registerCommand description
NataliaTepluhina Nov 11, 2018
e11d0b2
feat: Add a description for adding new vue-cli-service command
NataliaTepluhina Nov 13, 2018
7ee3620
fix: Change the part about modifying existing vue-cli-service commands
NataliaTepluhina Nov 13, 2018
74db35b
feat: Add local installation steps for cli-plugin with/without Vue UI
NataliaTepluhina Nov 17, 2018
6984c64
feat: Add generator extending package and changing main file chapters
NataliaTepluhina Nov 17, 2018
4fe263f
Merge commit '7d2b345af3b029205675366b725c521e5ccd0495' into plugin-docs
NataliaTepluhina Nov 17, 2018
8a254cb
feat: Add templating part to vue-cli-plugin Generator docs
NataliaTepluhina Nov 18, 2018
114e625
feat: described prompts
NataliaTepluhina Nov 18, 2018
803a42c
fix: fixed condition on template rendering in generator
NataliaTepluhina Nov 18, 2018
c2f0147
Merge branch 'dev' of github.com:vuejs/vue-cli into dev
NataliaTepluhina Nov 26, 2018
624f3e4
fix: Merge dev into docs
NataliaTepluhina Nov 26, 2018
70f2134
Merge branch 'dev' of github.com:vuejs/vue-cli into dev
NataliaTepluhina Nov 28, 2018
f50858c
Merge branch 'dev' into plugin-docs
NataliaTepluhina Nov 28, 2018
9e28f0a
fix: changed Getting Started part
NataliaTepluhina Nov 28, 2018
7b2916b
fix: Added links to Generator and Prompts chapters; fixed a descripti…
NataliaTepluhina Nov 28, 2018
9d6e46d
Merge branch 'up-dev' into plugin-docs
NataliaTepluhina Nov 29, 2018
2e9ac27
fix: reverted changed to Heroku deployment
NataliaTepluhina Nov 29, 2018
0f9fd1f
fix: restored Surge chapter
NataliaTepluhina Nov 29, 2018
4d5cfe8
fix: deleted unused image
NataliaTepluhina Nov 29, 2018
0f98c33
Merge branch 'up-dev' into plugin-docs
NataliaTepluhina Nov 30, 2018
10f54d7
Merge branch 'up-dev' into plugin-docs
NataliaTepluhina Nov 30, 2018
64bb8b2
fix: changed an order of chapters; added description for Generator part
NataliaTepluhina Dec 3, 2018
634490d
Update docs/dev-guide/plugin-dev.md
Justineo Dec 6, 2018
49b0449
fix: rewrote the Generator part
NataliaTepluhina Dec 7, 2018
58fa84a
feat: add description for extending a package with new command
NataliaTepluhina Dec 8, 2018
6934f48
fix: fixed service plugin description and links
NataliaTepluhina Dec 8, 2018
2c8bc51
fix: fixed links and typos, added prompt API
NataliaTepluhina Dec 8, 2018
d07766e
Merge branch 'up-dev' into plugin-docs
NataliaTepluhina Dec 9, 2018
a6322b6
feat: UI description and augmenting task in the UI
NataliaTepluhina Dec 13, 2018
efd0b0e
feat: added a description for configuration screen in UI
NataliaTepluhina Dec 17, 2018
9032cca
Merge branch 'up-dev' into plugin-docs
NataliaTepluhina Dec 17, 2018
4698619
feat: add configuration files description
NataliaTepluhina Dec 18, 2018
ee349ab
feat: add save config description
NataliaTepluhina Dec 18, 2018
816a84a
feat: add prompts-in-UI description
NataliaTepluhina Dec 19, 2018
a1ae893
feat: added logo and discoverability sections
NataliaTepluhina Dec 20, 2018
4ef81eb
feat: add publish plugin to npm section
NataliaTepluhina Dec 20, 2018
3d5d77e
feat: stated plugin API reference
NataliaTepluhina Dec 20, 2018
fc6023d
fix: fixed typo in quote
NataliaTepluhina Dec 22, 2018
8fa326a
feat: Plugin API reference ready
NataliaTepluhina Dec 24, 2018
c6dfe28
fix: removed examples
NataliaTepluhina Dec 26, 2018
43fb728
feat: add Generator API reference
NataliaTepluhina Dec 26, 2018
5ac6f88
Merge branch 'up-dev' into plugin-docs
NataliaTepluhina Dec 26, 2018
5b4804e
fix: fixed typo in prompt
Akryum Dec 26, 2018
76d0fcb
fix: remove underscore in `_path` parameter
NataliaTepluhina Dec 26, 2018
ba4a529
Update docs/dev-guide/plugin-dev.md
Akryum Dec 26, 2018
802fb8d
fix: add export to the templating example
NataliaTepluhina Dec 26, 2018
e5054f3
fix: change preposition
Akryum Dec 26, 2018
dfa6e35
fix: add missing `{`
NataliaTepluhina Dec 26, 2018
3d102bb
Update docs/dev-guide/plugin-dev.md
Akryum Dec 26, 2018
45bcb68
fix: specified that package.json should be user's one
Akryum Dec 26, 2018
42de3c2
fix: add dot
Akryum Dec 26, 2018
b50acd0
fix: add dot
Akryum Dec 26, 2018
c866706
fix: missing bracket
Akryum Dec 26, 2018
66f6095
fix: add dot
Akryum Dec 26, 2018
295834e
fix: add dot
Akryum Dec 26, 2018
90b9bbe
fix: add dot
Akryum Dec 26, 2018
69ba97d
fix: add colon
Akryum Dec 26, 2018
e721596
fix: add semicolon
Akryum Dec 26, 2018
5846422
fix: add semicolon
Akryum Dec 26, 2018
6104d7a
fix: add semicolon
Akryum Dec 26, 2018
ebc633e
fix: typo in `it's` vs `its`
Akryum Dec 26, 2018
9b16c8d
feat: add more places for logo to display
Akryum Dec 26, 2018
136926c
fix: add vue add option to invocation
Akryum Dec 26, 2018
eb7ea91
fix: add fe missed brackets and moved filename section
NataliaTepluhina Dec 26, 2018
d59266b
fix: fix indentations and remove OPTIONS constant
NataliaTepluhina Dec 26, 2018
26a011f
fix: fix indentation and wrap built-in plugin description with a tip
NataliaTepluhina Dec 26, 2018
f1a2ec2
fix: add link to Public static files
NataliaTepluhina Dec 26, 2018
30527e7
fix: change the description for UI prompts properties
NataliaTepluhina Dec 26, 2018
c360894
fix: add `@scope/vue-cli-plugin-<name>` option
NataliaTepluhina Dec 26, 2018
7489a91
fix: code style fixes
NataliaTepluhina Dec 26, 2018
975a9e1
fix: change config id to follow reverse domain name notation
NataliaTepluhina Dec 26, 2018
08a64ce
fix: style fixes
NataliaTepluhina Dec 26, 2018
9b43442
feat: add more comments with file names
NataliaTepluhina Dec 26, 2018
e5b5060
Merge branch 'dev' into plugin-docs
Akryum Jan 24, 2019
cc1cbaa
docs: fixes
Akryum Jan 24, 2019
43e0121
docs: removed built-it plugins prompts part
NataliaTepluhina Jan 25, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,14 @@ module.exports = {
],
'/dev-guide/': [
'/dev-guide/plugin-dev.md',
{
title: 'API reference',
collapsable: false,
children: [
'/dev-guide/plugin-api.md',
'/dev-guide/generator-api.md',
]
},
{
title: 'UI Development',
collapsable: false,
Expand Down
Binary file added docs/.vuepress/public/generator-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/prompts-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/ui-browse-local-plugin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/ui-plugin-refresh.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/ui-project-manager.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.vuepress/public/ui-select-plugin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/dev-guide/generator-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Generator API
1 change: 1 addition & 0 deletions docs/dev-guide/plugin-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Plugin API
Loading