🎨 Use version 1 of VuePress

📝 Improve documentation about using VuePress 1.5

⬆️ 📦 vuepress
✨ 📦 @vuepress/plugin-google-analytics

Author: nelson6e65

README.md

@@ -44,9 +44,9 @@ Explore sources of [nelson6e65/phpdoc-vuepress](https://github.com/nelson6e65/ph
 - Node.js >= 8
 - [phpDocumentor](https://www.phpdoc.org/).
 - [Yarn](https://yarnpkg.com) (or npm)
-- [VuePress](https://v0.vuepress.vuejs.org/).
+- [VuePress](https://vuepress.vuejs.org/).
 
-> This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 0.x](https://v0.vuepress.vuejs.org/).
+> This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 1](https://v0.vuepress.vuejs.org/).
 > Read more about dependencies in the [Documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/getting-started.html).
 
 ## Installation
@@ -56,7 +56,7 @@ Install `nelson6e65/phpdoc-vuepress` with composer:
 ```bash
 composer require --dev nelson6e65/phpdoc-vuepress
 ```
-
+ 
 > You may need to set the composer option [minimum-stability](https://getcomposer.org/doc/04-schema.md#minimum-stability) to 'dev' in order to be able to install pre-releases.
 
 

docs/.vuepress/config.js

@@ -11,6 +11,13 @@ module.exports = {
   // Description of your project
   description: 'Template for generating your PHP API documentation in a pretty VuePress format',
 
+  // Plugins config
+  plugins: {
+    '@vuepress/google-analytics': {
+      ga: 'UA-58599811-1' // GoogleAnalytics ID (optional. use your own ga)
+    }
+  },
+
   themeConfig: {
     nav: [
       { text: 'Guide', link: '/guide/' }, // Link to a non-api-documentation section
@@ -71,7 +78,5 @@ module.exports = {
     repo: 'nelson6e65/phpdoc-vuepress',
     docsDir: 'docs',
     editLinks: true,
-
-    ga: 'UA-58599811-1' // GoogleAnalytics ID.
   }
 }

docs/guide/README.md

@@ -42,7 +42,7 @@ Check a demo of documentation generated with this template in [Demo](/demo/)
 
 ![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)
 
-Copyright (c) 2018-2019 Nelson Martell
+Copyright (c) 2018-2020 Nelson Martell
 
 Read the [`LICENSE` file](https://github.com/nelson6e65/phpdoc-vuepress/blob/master/LICENSE) for details.
 

docs/guide/configuration.md

@@ -36,7 +36,9 @@ Then, you can just run `phpdoc`.
 
 ## Configuring VuePress
 
-If you don't already have configured your VuePress, create  **`docs/.vuepress/config.js`** following the ***Config Reference*** according to [v0.x](https://v0.vuepress.vuejs.org/config/) or [v1.x](https://vuepress.vuejs.org/config/) version of VuePress you use.
+If you don't already have configured your VuePress, you can follow the [setup instructions](https://vuepress.vuejs.org/guide/getting-started.html).
+
+> Depending on version you are using, the **`docs/.vuepress/config.js`** file you created should following the ***Config Reference*** according to [v0.x](https://v0.vuepress.vuejs.org/config/) or [v1.x](https://vuepress.vuejs.org/config/).
 
 Once done, you only need to include the files generated by ***phpDocumentor*** in your sidebar as you like.
 
@@ -71,7 +73,7 @@ If you installed VuePress as project dependency, you can configure scripts in yo
 }
 ```
 
-And then just run `yarn docs:build` :sunglasses:.
+And then just run `npm run docs:build` :sunglasses:.
 :::
 
 > Read about recommended directory structure at [https://vuepress.vuejs.org/guide/directory-structure.html](https://vuepress.vuejs.org/guide/directory-structure.html)

docs/guide/getting-started.md

@@ -8,22 +8,20 @@
 
 ### Dependencies
 
-This template is designed for [phpDocumentor 2](https://www.phpdoc.org/) and [VuePress 0.x](https://v0.vuepress.vuejs.org/).
-
-> This template may be compatible with upcoming **phpDocumentor3** and **VuePress** v1.0.0, but will not be documented at the moment while they are unstable.
+- **phpDocumentor**: This template is designed for [phpDocumentor 2.x (2.9.1)](https://github.com/phpDocumentor/phpDocumentor#phpdocumentor), but may be compatible with upcoming **phpDocumentor3**.
+- **VuePress**: You can use the [version 1.x](https://v1.vuepress.vuejs.org/) by default, but you can also use [version 0.x](https://v0.vuepress.vuejs.org/), depending on your configuration compatibility.
 
 You can globally install them:
 
 ```bash
-# phpDocumentor2
+# phpDocumentor2 globally
 composer global require phpdocumentor/phpdocumentor:^2.9.0
 
 # VuePress
-yarn global add vuepress
+npm i -D vuepress
 ```
 
-> Read about [VuePress install](https://v0.vuepress.vuejs.org/guide/getting-started.html).
-
+> Read about [VuePress install](https://vuepress.vuejs.org/guide/getting-started.html).
 
 
 ## Installation

package-lock.json

@@ -6,7 +6,8 @@
   "license": "MIT",
   "private": true,
   "dependencies": {
-    "vuepress": "^0.14.8"
+    "@vuepress/plugin-google-analytics": "^1.5.3",
+    "vuepress": "^1.5.3"
   },
   "scripts": {
     "docs:dev": "vuepress dev docs",