Skip to content

Commit 4b2a11e

Browse files
NataliaTepluhinaAkryum
authored andcommitted
docs: Plugin development guide (#2973)
* feat(docs): add Heroku deployment section * fix: rename remote repository section title * fix(docs): add a middleware for handling vue-router in deployed app * fix(docs): fixed formatting * feat: Create structure for Plugin and Generator API; create Getting started and Modifying webpack config chapters * feat: started registerCommand description * feat: Add a description for adding new vue-cli-service command * fix: Change the part about modifying existing vue-cli-service commands * feat: Add local installation steps for cli-plugin with/without Vue UI * feat: Add generator extending package and changing main file chapters * feat: Create structure for Plugin and Generator API; create Getting started and Modifying webpack config chapters * feat: started registerCommand description * feat: Add a description for adding new vue-cli-service command * fix: Change the part about modifying existing vue-cli-service commands * feat: Add local installation steps for cli-plugin with/without Vue UI * feat: Add generator extending package and changing main file chapters * feat: Add templating part to vue-cli-plugin Generator docs * feat: described prompts * fix: fixed condition on template rendering in generator * fix: changed Getting Started part * fix: Added links to Generator and Prompts chapters; fixed a description for testing a plugin locally * fix: reverted changed to Heroku deployment * fix: restored Surge chapter * fix: deleted unused image * fix: changed an order of chapters; added description for Generator part * Update docs/dev-guide/plugin-dev.md Co-Authored-By: NataliaTepluhina <[email protected]> * fix: rewrote the Generator part * feat: add description for extending a package with new command * fix: fixed service plugin description and links * fix: fixed links and typos, added prompt API * feat: UI description and augmenting task in the UI * feat: added a description for configuration screen in UI * feat: add configuration files description * feat: add save config description * feat: add prompts-in-UI description * feat: added logo and discoverability sections * feat: add publish plugin to npm section * feat: stated plugin API reference * fix: fixed typo in quote * feat: Plugin API reference ready * fix: removed examples * feat: add Generator API reference * fix: fixed typo in prompt Co-Authored-By: NataliaTepluhina <[email protected]> * fix: remove underscore in `_path` parameter * Update docs/dev-guide/plugin-dev.md Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add export to the templating example * fix: change preposition Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add missing `{` * Update docs/dev-guide/plugin-dev.md Co-Authored-By: NataliaTepluhina <[email protected]> * fix: specified that package.json should be user's one Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add dot Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add dot Co-Authored-By: NataliaTepluhina <[email protected]> * fix: missing bracket Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add dot Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add dot Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add dot Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add colon Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add semicolon Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add semicolon Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add semicolon Co-Authored-By: NataliaTepluhina <[email protected]> * fix: typo in `it's` vs `its` Co-Authored-By: NataliaTepluhina <[email protected]> * feat: add more places for logo to display Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add vue add option to invocation Co-Authored-By: NataliaTepluhina <[email protected]> * fix: add fe missed brackets and moved filename section * fix: fix indentations and remove OPTIONS constant * fix: fix indentation and wrap built-in plugin description with a tip * fix: add link to Public static files * fix: change the description for UI prompts properties * fix: add `@scope/vue-cli-plugin-<name>` option * fix: code style fixes * fix: change config id to follow reverse domain name notation * fix: style fixes * feat: add more comments with file names * docs: fixes * docs: removed built-it plugins prompts part
1 parent 702a2c9 commit 4b2a11e

15 files changed

+935
-195
lines changed

docs/.vuepress/config.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,14 @@ module.exports = {
109109
],
110110
'/dev-guide/': [
111111
'/dev-guide/plugin-dev.md',
112+
{
113+
title: 'API reference',
114+
collapsable: false,
115+
children: [
116+
'/dev-guide/plugin-api.md',
117+
'/dev-guide/generator-api.md',
118+
]
119+
},
112120
{
113121
title: 'UI Development',
114122
collapsable: false,
50.7 KB
Loading
62.3 KB
Loading
309 KB
Loading
143 KB
Loading
331 KB
Loading
287 KB
Loading
179 KB
Loading
248 KB
Loading
309 KB
Loading

0 commit comments

Comments
 (0)