🎨 Improve documentation with some logos

Author: nelson6e65

.github/assets/card.svg

@@ -1,4 +1,6 @@
-# phpDocumentor VuePress template
+![Card](.github/card.svg)
+
+# PHPDoc-VuePress
 [![Travis Build Status](https://img.shields.io/travis/nelson6e65/phpdoc-vuepress/master.svg?logo=travis)](https://travis-ci.org/nelson6e65/phpdoc-vuepress)
 ![PHP Versions](https://img.shields.io/travis/php-v/nelson6e65/phpdoc-vuepress.svg)
 
@@ -13,7 +15,7 @@
 
 Template for generating your PHP API documentation in a pretty VuePress format.
 
-This package provides a **phpDocumentor** template to generates the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project.
+This package provides a **phpDocumentor** template to generate the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project.
 
 > Only tested with the default theme of VuePress.
 
@@ -56,7 +58,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.
 
 
@@ -86,7 +88,7 @@ Check the documentation for more information [https://nelson6e65.github.io/phpdo
 
 [![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)](LICENSE)
 
-Copyright (c) 2018-2019 Nelson Martell
+Copyright (c) 2018-2020 Nelson Martell
 
 Read the [`LICENSE` file](LICENSE) for details.
 

README.md

@@ -6,11 +6,15 @@ module.exports = {
   base: '/phpdoc-vuepress/',
 
   // Title of your project
-  title: 'phpdoc-vuepress',
+  title: 'PHPDoc-VuePress',
 
   // Description of your project
   description: 'Template for generating your PHP API documentation in a pretty VuePress format',
 
+  head: [
+    ['link', { rel: 'icon', href: '/favicon.svg' }] // Custom favicon
+  ],
+
   // Plugins config
   plugins: {
     '@vuepress/google-analytics': {
@@ -78,5 +82,14 @@ module.exports = {
     repo: 'nelson6e65/phpdoc-vuepress',
     docsDir: 'docs',
     editLinks: true,
+  },
+
+  // custom webpack configuration
+  configureWebpack: {
+    resolve: {
+      alias: { // Aliases
+        '@github': '../../.github/assets'
+      }
+    }
   }
 }

docs/.vuepress/config.js

@@ -1,11 +1,12 @@
 ---
 home: true
-heroText: "phpdoc-vuepress"
+heroText: PHPDoc-VuePress
+heroImage: /hero.svg
 tagline: Template for generating your PHP API documentation in a pretty VuePress format
 actionText: Get Started →
 actionLink: /guide/
 
-footer: MIT Licensed | Copyright © 2018-2019 Nelson Martell
+footer: MIT Licensed | Copyright © 2018-2020 Nelson Martell
 
 features:
 - title: Document all your code

docs/.vuepress/public/favicon.svg

@@ -1,3 +1,6 @@
+
+![Card](~@github/card.svg)
+
 # Introduction
 
 ![GitHub release](https://img.shields.io/github/tag/nelson6e65/phpdoc-vuepress.svg?logo=github)
@@ -6,11 +9,11 @@
 
 ![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)
 
-::: tip phpdoc-vuepress
+::: tip PHPDoc-VuePress
 Template for generating your PHP API documentation in a pretty VuePress format.
 :::
 
-This package provides a **phpDocumentor** template to generates the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project.
+This package provides a **phpDocumentor** template to generate the API documentation of your code to be integrated in a nice looking [VuePress](https://vuepress.vuejs.org) project.
 
 > Only tested with the default theme of VuePress.
 

docs/.vuepress/public/hero.svg

@@ -9,7 +9,7 @@ You need to tell phpDocumentor (1) where are your PHP source files, (2) where to
 In order to accomplish this, you must create a configuration file named  `phpdoc.dist.xml` and setup (1, 2, and 3).
 
 :::tip Template location [3]
-If you installed via Composer, the template will be `vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress`.
+If you installed via Composer, the template will be located at `vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress` directory.
 
 ```xml
 <transformations>