From 5b32425a07fc395095d3598d8033a52094127364 Mon Sep 17 00:00:00 2001 From: Chris Fritz Date: Wed, 1 Aug 2018 10:11:03 +0200 Subject: [PATCH 1/2] various doc recommendations --- docs/.vuepress/config.js | 26 +- docs/README.md | 23 +- docs/{cookbook/README.md => examples.md} | 6 +- docs/getting-started.md | 17 + docs/guide/README.md | 18 - docs/options.md | 61 +- package.json | 3 +- yarn.lock | 4179 +++++++++++++++++++++- 8 files changed, 4172 insertions(+), 161 deletions(-) rename docs/{cookbook/README.md => examples.md} (74%) create mode 100644 docs/getting-started.md delete mode 100644 docs/guide/README.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 2f9d178..6dcf3f0 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -17,31 +17,33 @@ module.exports = { label: 'English', selectText: 'Languages', editLinkText: 'Edit this page on GitHub', - nav: [{ - text: 'Guide', - link: '/guide/' + nav: [ + { + text: 'Getting Started', + link: '/getting-started/' + }, + { + text: 'Examples', + link: '/examples/' }, { - text: 'Options Reference', + text: 'Options', link: '/options' }, { text: 'Migrating from v2', link: '/migrating' - }, - { - text: 'Cookbook', - link: '/cookbook/' } ], sidebar: [ - '/', - '/guide/', + { + title: 'Guide', + children: ['/', '/getting-started', '/examples'] + }, '/options', - '/cookbook/', '/changelog' ] } } } -} \ No newline at end of file +} diff --git a/docs/README.md b/docs/README.md index 812e8d1..07d7047 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,20 +4,20 @@ This is the documentation for Rollup Plugin Vue v4 and above. If you are upgrading from v2 or an earlier version, check out the [Migration Guide](./migrating.md). If you are using an older version, the old docs are [here](https://github.com/vuejs/rollup-plugin-vue/tree/2.2/docs). ::: -## What is Rollup Plugin Vue? +## What does Rollup Plugin Vue do? -`rollup-plugin-vue` is a plugin for [rollup](https://rollupjs.org/) that allows you to author Vue components in a format called [Single-File Components (SFCs)](https://vue-loader.vuejs.org/spec.html): +This is a plugin for [rollup](https://rollupjs.org/) that allows you to author Vue components in a format called [Single-File Components (SFCs)](https://vue-loader.vuejs.org/spec.html). They look like this: ``` vue