chore: setup docs

Author: iodsfx3d

docs/.gitkeep

@@ -0,0 +1,33 @@
+module.exports = {
+  title: 'Vue Router Middleware Plugin',
+  description: 'The vue router middleware pipeline you deserve',
+  themeConfig: {
+    nav: [
+      { text: 'Guide', link: '/guide/' },
+      { text: 'API', link: '/api/' },
+      { text: 'GitHub', link: 'https://github.com/dsfx3d/vue-router-middleware-plugin'}
+    ],
+    sidebar: {
+      '/guide/': [
+        {
+          title: 'Guide',
+          collapsable: false,
+          children: [
+            ''
+          ]
+        }
+      ],
+      '/api/': [
+        {
+          title: 'API Reference',
+          collapsable: false,
+          children: [
+            '',
+            'context',
+            'options'
+          ]
+        }
+      ]
+    }
+  }
+}

docs/.vuepress/config.js

@@ -0,0 +1,15 @@
+---
+home: true
+heroText: Middleware Plugin
+tagline: The middleware pipeline you deserve
+actionText: Get Started →
+actionLink: /guide/
+features:
+- title: Performant
+  details: Inspired from Nuxt Middlewares and built on top of vue router's Navigation Guards to offer the best of performance.
+- title: Light-Weight
+  details: A light weight but powerful middleware pipeline to control logic between your routes.
+- title: Extensible
+  details: The plugin API is inherently extensible to use within your applications or in integration with third-party plugins.
+footer: MIT Licensed | Copyright © 2020 @dsfx3d
+---

docs/README.md

@@ -0,0 +1,3 @@
+# Configuration
+
+Pass the configuration object

docs/api/README.md

@@ -0,0 +1,42 @@
+# Context
+
+The `context` or middleware context is the only argument in all middleware functions. It's an object which provide properties which can be used to control the behaviour of a middleware
+
+```javascript
+export default ({ app, to, from, redirect }) => {
+  if (to.path === '/protected') {
+    redirect(from)
+  } else {
+    const { visits } = app.$getMiddlewareContext()
+    app.$updateMiddlewareContext('visits', (visits || 0) + 1)
+  }
+}
+```
+
+## Built-In Properties
+
+The context has the following built-in properties:
+
+### `app: VueConstructor`
+
+A regular vue constructor with injected plugin [options](options/).
+
+### `to: Route`
+
+The target [Route Object](https://router.vuejs.org/api/#the-route-object) being navigated to.
+
+*An argument from [Navigation Guard](https://router.vuejs.org/guide/advanced/navigation-guards.html#global-before-guards)*
+
+### `from: Route`
+
+The target [Route Object](https://router.vuejs.org/api/#the-route-object) being navigated from.
+
+*An argument from [Navigation Guard](https://router.vuejs.org/guide/advanced/navigation-guards.html#global-before-guards)*
+
+### `redirect: function`
+
+A function to redirect to any route. Accepts same arguments as the `next` function in a [Navigation Guard](https://router.vuejs.org/guide/advanced/navigation-guards.html#global-before-guards) but unlike a navigation guard, it's not required to be called in each middleware in order to resolve it.
+
+## Adding custom properties
+
+From the example above, we are appearently adding a property `visits` to the middleware context. Goto [options](options/) for more.

docs/api/context.md

@@ -0,0 +1 @@
+# Options

docs/api/options.md

@@ -0,0 +1 @@
+# Introduction