Initial commit.

Author: neogeek

.eslintrc

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "@neogeek/eslint-config-standards"
+  ]
+}

.gitignore

@@ -0,0 +1 @@
+node_modules/

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Scott Doxey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,15 @@
+# doxdox-plugin-markdown
+
+> Markdown template plugin for doxdox.
+
+## Install
+
+```bash
+$ npm install doxdox doxdox-plugin-markdown --save-dev
+```
+
+## Usage
+
+```bash
+$ doxdox lib/ --layout markdown --output DOCUMENTATION.md
+```

index.js

@@ -0,0 +1,24 @@
+const fs = require('fs');
+const path = require('path');
+
+const Handlebars = require('handlebars');
+
+const plugin = data => new Promise((resolve, reject) => {
+
+    fs.readFile(path.join(__dirname, './template.hbs'), 'utf8', (err, contents) => {
+
+        if (err) {
+
+            return reject(err);
+
+        }
+
+        const template = Handlebars.compile(contents);
+
+        return resolve(template(data));
+
+    });
+
+});
+
+module.exports = plugin;

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "doxdox-plugin-markdown",
+  "description": "Markdown template plugin for doxdox.",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "handlebars": "4.0.5"
+  },
+  "devDependencies": {
+    "@neogeek/eslint-config-standards": "1.6.3",
+    "eslint": "3.8.0"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "doxdox",
+    "plugin",
+    "markdown"
+  ],
+  "authors": [
+    {
+      "name": "Scott Doxey",
+      "email": "hello@scottdoxey.com",
+      "homepage": "http://scottdoxey.com/"
+    }
+  ],
+  "homepage": "https://github.com/neogeek/doxdox-plugin-markdown",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/neogeek/doxdox-plugin-markdown.git"
+  }
+}

template.hbs

@@ -0,0 +1,73 @@
+{{#if pkg.homepage}}
+# [{{title}}]({{pkg.homepage}}) {{#if pkg.version}}*{{pkg.version}}*{{/if}}
+{{else}}
+# {{title}} {{#if pkg.version}}*{{pkg.version}}*{{/if}}
+{{/if}}
+
+{{#if description}}
+> {{description}}
+{{/if}}
+
+{{#each files}}
+
+### {{name}}
+
+{{#each methods}}
+
+#### {{name}}({{params}}) {{#if isPrivate}} *private method*{{/if}}
+
+{{{description}}}
+
+{{{body}}}
+
+{{#if tags.param}}
+
+##### Parameters
+
+{{#each tags.param}}
+- **{{name}}** {{#each types}}`{{.}}` {{/each}} {{#if isOptional}}*Optional*{{/if}} {{{description}}}
+{{/each}}
+
+{{/if}}
+
+{{#if tags.property}}
+
+##### Properties
+
+{{#each tags.property}}
+- **{{name}}** {{#each types}}`{{.}}` {{/each}} {{#if isOptional}}*Optional*{{/if}} {{{description}}}
+{{/each}}
+
+{{/if}}
+
+{{#if tags.example}}
+
+##### Examples
+
+{{#each tags.example}}
+```javascript
+{{{.}}}
+```
+{{/each}}
+
+{{/if}}
+
+##### Returns
+
+{{#if tags.return}}
+
+{{#each tags.return}}
+- {{#each types}}`{{.}}` {{/each}} {{#if isOptional}}*Optional*{{/if}} {{{description}}}
+{{/each}}
+
+{{else}}
+
+- `Void`
+
+{{/if}}
+
+{{/each}}
+
+{{/each}}
+
+*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*