🎨 prettify the code

Author: nelson6e65

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,13 +1,13 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
 assignees: nelson6e65
-
 ---
 
 **Scopes**
+
 - [ ] Installation
 - [ ] Documentation
 - [ ] Template (twig, xml)
@@ -17,13 +17,12 @@ assignees: nelson6e65
 - [ ] Appearance
 - [ ] Other
 
-
 **Describe the bug**
 A clear and concise description of what the bug is.
 
-
 **Steps to reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -36,16 +35,19 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Enviroment:**
- - **OS**: [e.g. Fedora 29, Windows 7, etc]
- - **Browser**: [e.g. chrome, safari]
+
+- **OS**: [e.g. Fedora 29, Windows 7, etc]
+- **Browser**: [e.g. chrome, safari]
 
 **Versions:**
- - **Template**:
- - PHP:
- - Node:
- - Yarn:
- - **VuePress**:
- - **phpDocumentor**:
+
+- **Template**:
+- PHP:
+- Node:
+- Yarn:
+- **VuePress**:
+- **phpDocumentor**:
 
 **Additional context**
+
 <!-- Add any other context about the problem here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -3,11 +3,11 @@ name: Feature request
 about: Suggest an idea for this project
 title: "[feature] "
 labels: enhancement
-assignees: ''
-
+assignees: ""
 ---
 
 **Scopes**
+
 - [ ] Installation
 - [ ] Documentation
 - [ ] Template (twig, xml)
@@ -17,7 +17,6 @@ assignees: ''
 - [ ] Appearance
 - [ ] Other
 
-
 **Is your feature request related to a problem? Please describe.**
 A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
 

.github/ISSUE_TEMPLATE/question.md

@@ -3,11 +3,11 @@ name: Question
 about: Questions about usage or misunderstood instructions.
 title: "[question] How to ____?"
 labels: question
-assignees: ''
-
+assignees: ""
 ---
 
 **Scopes**
+
 - [ ] Installation
 - [ ] Documentation
 - [ ] Template (twig, xml)

.travis.yml

@@ -8,8 +8,8 @@ php:
   - 7.3
 
 cache:
-- npm
-- composer
+  - npm
+  - composer
 
 env:
   global:
@@ -30,7 +30,6 @@ matrix:
     - php: 5.6
     - php: 7.0
 
-
 before_install:
   # Update composer
   - composer self-update

README.md

@@ -1,6 +1,7 @@
 [![Card](./.github/assets/card.svg)](https://nelson6e65.github.io/phpdoc-vuepress)
 
 # 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)
 
@@ -12,7 +13,6 @@
 [![Documentation](http://img.shields.io/badge/📜-Documentation-lightgrey.svg)](https://nelson6e65.github.io/phpdoc-vuepress)
 [![Wakatime](https://wakatime.com/badge/github/nelson6e65/phpdoc-vuepress.svg)](https://wakatime.com/badge/github/nelson6e65/phpdoc-vuepress)
 
-
 Template for generating your PHP API documentation in a pretty VuePress format.
 
 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.
@@ -30,7 +30,6 @@ This template will generate six VuePress `*.md` files with the DocBlock document
 - `constants.md`: Contains all global constants, sorted by namespace.
 - `functions.md`: Contains all global functions, sorted by namespace.
 
-
 ## Demo
 
 Check a demo of documentation generated with this template in http://nelson6e65.github.io/phpdoc-vuepress/demo/
@@ -39,7 +38,6 @@ Explore sources of [nelson6e65/phpdoc-vuepress](https://github.com/nelson6e65/ph
 
 > A real project API generated using this template: [nelson6e65.github.io/php_nml/api/](https://nelson6e65.github.io/php_nml/api/).
 
-
 ## Requirements
 
 - PHP >= 5.6
@@ -61,29 +59,24 @@ 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.
 
-
 ## Usage
 
 Run phpDocumentor and set template as `vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress`:
 
-
 ```bash
 phpdoc -d="src/" -t="docs/api/" --template="vendor/nelson6e65/phpdoc-vuepress/data/templates/vuepress"
 ```
 
 > More information about the available arguments can be found at [running phpDocumentor](http://www.phpdoc.org/docs/latest/guides/running-phpdocumentor.html).
 
-
 ## Configuration
 
 See the [Configuration section in the documentation](https://nelson6e65.github.io/phpdoc-vuepress/guide/configuration.html) for setup examples.
 
-
 ## Further reading
 
 Check the documentation for more information [https://nelson6e65.github.io/phpdoc-vuepress/](https://nelson6e65.github.io/phpdoc-vuepress/).
 
-
 ## License
 
 [![License](https://img.shields.io/github/license/nelson6e65/phpdoc-vuepress.svg)](LICENSE)

composer.json

@@ -1,41 +1,48 @@
 {
-    "name": "nelson6e65/phpdoc-vuepress",
-    "description": "Template for generating your PHP API documentation in a pretty VuePress format.",
-    "keywords" : [ "PHPDoc", "PHP", "phpDocumentor", "Documentation", "Markdown", "VuePress" ],
-    "homepage" : "https://github.com/nelson6e65/phpdoc-vuepress",
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Nelson Martell",
-            "email": "nelson6e65@gmail.com"
-        }
-    ],
-    "autoload": {
-        "psr-4": {
-            "NelsonMartell\\VuePress\\": "src"
-        }
+  "name": "nelson6e65/phpdoc-vuepress",
+  "description": "Template for generating your PHP API documentation in a pretty VuePress format.",
+  "keywords": [
+    "PHPDoc",
+    "PHP",
+    "phpDocumentor",
+    "Documentation",
+    "Markdown",
+    "VuePress"
+  ],
+  "homepage": "https://github.com/nelson6e65/phpdoc-vuepress",
+  "license": "MIT",
+  "authors": [
+    {
+      "name": "Nelson Martell",
+      "email": "nelson6e65@gmail.com"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "NelsonMartell\\VuePress\\": "src"
+    }
+  },
+  "require-dev": {
+    "phpdocumentor/phpdocumentor": "^2.9",
+    "jms/serializer": "1.7.*"
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "NelsonMartell\\VuePress\\Demo\\": "demo"
     },
-    "require-dev": {
-        "phpdocumentor/phpdocumentor": "^2.9",
-        "jms/serializer": "1.7.*"
-    },
-    "autoload-dev": {
-		"psr-4": {
-			"NelsonMartell\\VuePress\\Demo\\": "demo"
-		},
-        "files": [
-			"demo/constants.php",
-			"demo/functions.php"
-		]
-	},
-    "scripts": {
-		"build:api": [
-			"phpdoc --ansi"
-		]
-	},
-    "extra": {
-		"branch-alias": {
-			"dev-master": "1.0.x-dev"
-		}
-	}
+    "files": [
+      "demo/constants.php",
+      "demo/functions.php"
+    ]
+  },
+  "scripts": {
+    "build:api": [
+      "phpdoc --ansi"
+    ]
+  },
+  "extra": {
+    "branch-alias": {
+      "dev-master": "1.0.x-dev"
+    }
+  }
 }

docs/.vuepress/config.js

@@ -12,14 +12,14 @@ module.exports = {
   description: 'Template for generating your PHP API documentation in a pretty VuePress format',
 
   head: [
-    ['link', { rel: 'icon', href: '/favicon.svg' }] // Custom favicon
+    ['link', { rel: 'icon', href: '/favicon.svg' }], // Custom favicon
   ],
 
   // Plugins config
   plugins: {
     '@vuepress/google-analytics': {
-      ga: 'UA-58599811-1' // GoogleAnalytics ID (optional. use your own ga)
-    }
+      ga: 'UA-58599811-1', // GoogleAnalytics ID (optional. use your own ga)
+    },
   },
 
   themeConfig: {
@@ -29,16 +29,18 @@ module.exports = {
     ],
 
     sidebar: {
-      '/guide/': [ // Normal documentation sidebar
+      '/guide/': [
+        // Normal documentation sidebar
         {
           title: 'Guide',
           collapsable: false,
-          children: [ // Normal pages
+          children: [
+            // Normal pages
             '',
             'getting-started',
             'configuration',
-          ]
-        }
+          ],
+        },
       ],
 
       // Your API documentation sidebar
@@ -49,22 +51,20 @@ module.exports = {
         {
           title: 'API Demo',
           collapsable: false,
-          children: [ //
+          children: [
+            //
             '', // Ref. to the `README.md` file
             'classes', // Ref. to the `classes.md` file
             'interfaces', // Ref. to the `interfaces.md` file
             'traits', // Ref. to the `traits.md` file
             'functions', // Ref. to the `functions.md` file
-            'constants' // Ref. to the `constants.md` file
-          ]
-        }
+            'constants', // Ref. to the `constants.md` file
+          ],
+        },
       ],
-      '/': [
-        ''
-      ]
+      '/': [''],
     },
 
-
     // You can ignore the following optional customizations --------------------
 
     markdown: {
@@ -87,9 +87,10 @@ module.exports = {
   // custom webpack configuration
   configureWebpack: {
     resolve: {
-      alias: { // Aliases
-        '@github': '../../.github/assets'
-      }
-    }
-  }
-}
+      alias: {
+        // Aliases
+        '@github': '../../.github/assets',
+      },
+    },
+  },
+};

docs/README.md

@@ -9,15 +9,15 @@ actionLink: /guide/
 footer: MIT Licensed | Copyright © 2018-2020 Nelson Martell
 
 features:
-- title: Document all your code
-  details: Generate documentation for all your classes, interfaces and traits sorted by namespace. Also, include your global/namespaced functions and constants.
+  - title: Document all your code
+    details: Generate documentation for all your classes, interfaces and traits sorted by namespace. Also, include your global/namespaced functions and constants.
 
-- title: Easy integration
-  details: Combine your API documentation with your existent VuePress pages by simply adding the 5 generated files to your sidebar configuration as a group.
+  - title: Easy integration
+    details: Combine your API documentation with your existent VuePress pages by simply adding the 5 generated files to your sidebar configuration as a group.
 
-- title: Linked references
-  details: Navigate between classes/members references by just a click. Get references of inherited members
+  - title: Linked references
+    details: Navigate between classes/members references by just a click. Get references of inherited members
 
-- title: Searchable elements
-  details: Use the VuePress search in toolbar to find classes, interfaces, traits, functions and constants by name.
+  - title: Searchable elements
+    details: Use the VuePress search in toolbar to find classes, interfaces, traits, functions and constants by name.
 ---