🆕 Basic demo for configuration example

Author: nelson6e65

.gitignore

@@ -5,3 +5,4 @@ node_modules/
 dist/
 docs/api/
 docs/demo/
+output/

composer.json

@@ -19,9 +19,23 @@
         "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"
+		]
+	},
     "extra": {
 		"branch-alias": {
-			"dev-master": "v1.0.x-dev"
+			"dev-master": "1.0.x-dev"
 		}
 	}
 }

demo/Example.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace NelsonMartell\VuePress\Demo;
+
+/**
+ * Example class.
+ *
+ * @since 1.0.0
+ * @author Nelson Martell <nelson6e65@gmail.com>
+ */
+class Example implements IDemo
+{
+    /**
+     *
+     * @var string
+     */
+    protected $example = null;
+
+    public function __construct($example = 'demo')
+    {
+        $this->example = $example;
+    }
+
+    public function isReady()
+    {
+        return $this->example !== null;
+    }
+
+    protected function isDemo()
+    {
+        return $this->example === 'demo';
+    }
+}

demo/IDemo.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace NelsonMartell\VuePress\Demo;
+
+/**
+ * Example interface.
+ *
+ * @since 1.0.0
+ * @author Nelson Martell <nelson6e65@gmail.com>
+ */
+interface IDemo
+{
+    /**
+     * Example class constant.
+     *
+     * @var boolean
+     */
+    const EXAMPLE = true;
+
+    /**
+     * Is the example ready?
+     *
+     * @return bool
+     */
+    public function isReady();
+}

demo/constants.php

@@ -0,0 +1,14 @@
+<?php
+
+
+/**
+ * An example constant.
+ *
+ * @var string
+ *
+ * @return string
+ *
+ * @author Nelson Martell <nelson6e65@gmail.com>
+ * @since 1.0.0
+ */
+define('PV_DEMO_VERSION', '1.0.0');

demo/functions.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace NelsonMartell\VuePress\Demo;
+
+/**
+ * An example function.
+ *
+ * @param int         $index Index.
+ * @param string|null $name  Name.
+ *
+ * @return string
+ *
+ * @author Nelson Martell <nelson6e65@gmail.com>
+ * @since 1.0.0
+ */
+function example($index, $title = null)
+{
+    $r = 'Example '.$index;
+
+    if ($title) {
+        $r .= ' '.$title;
+    }
+
+    return $r.': ';
+}

docs/.vuepress/config.js

@@ -15,6 +15,7 @@ module.exports = {
   themeConfig: {
     nav: [
       { text: 'Guide', link: '/guide/' },
+      { text: 'Demo', link: '/api/' },
     ],
 
     sidebar: {
@@ -28,6 +29,20 @@ module.exports = {
           ]
         }
       ],
+      '/api/': [
+        {
+          title: 'Demo',
+          collapsable: false,
+          children: [
+            '',
+            'classes',
+            'interfaces',
+            'traits',
+            'functions',
+            'constants'
+          ]
+        }
+      ],
       '/': [
         ''
       ]
@@ -36,17 +51,9 @@ module.exports = {
 
     lastUpdated: true,
 
-
     // Repo
     repo: 'nelson6e65/phpdoc-vuepress',
     docsDir: 'docs',
-    editLinks: true,
-  },
-
-  configureWebpack: {
-    output: {
-      filename: '[name].js',
-      chunkFilename: 'assets/js/[name].js' + '?id=[chunkhash]'
-    }
+    editLinks: true
   }
 }

phpdoc.dist.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<phpdoc>
+  <title>Demo for `phpdoc-vuepress`</title>
+
+  <parser>
+    <visibility>public,protected</visibility>
+    <target>output/phpdoc/api</target>
+  </parser>
+
+  <transformer>
+    <target>docs/api</target>
+  </transformer>
+
+  <transformations>
+    <template name="data/templates/vuepress" />
+  </transformations>
+
+  <files>
+    <directory>demo</directory>
+  </files>
+
+</phpdoc>