Initial commit.

Author: neogeek

.eslintrc

@@ -0,0 +1,8 @@
+{
+  "extends": [
+    "@neogeek/eslint-config-standards"
+  ],
+  "rules": {
+    "new-cap": 0
+  }
+}

.gitignore

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

.npmignore

@@ -0,0 +1 @@
+.eslintrc

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,17 @@
+# doxdox-plugin-github-wiki
+
+> GitHub wiki export plugin for doxdox.
+
+[![NPM Version](http://img.shields.io/npm/v/doxdox-plugin-github-wiki.svg?style=flat)](https://www.npmjs.org/package/doxdox-plugin-github-wiki)
+
+## Install
+
+```bash
+$ npm install doxdox doxdox-plugin-github-wiki --save-dev
+```
+
+## Usage
+
+```bash
+$ doxdox 'src/**/*.js' --layout github-wiki --output wiki.zip
+```

index.js

@@ -0,0 +1,41 @@
+const fs = require('fs');
+const path = require('path');
+
+const Handlebars = require('handlebars');
+
+const admzip = require('adm-zip');
+
+const plugin = data => new Promise((resolve, reject) => {
+
+    const zip = new admzip();
+
+    fs.readFile(path.join(__dirname, 'template.hbs'), 'utf8', (err, contents) => {
+
+        if (err) {
+
+            return reject(err);
+
+        }
+
+        const template = Handlebars.compile(contents);
+
+        data.files.forEach(file => {
+
+            file.methods.forEach(method => {
+
+                zip.addFile(
+                    `${file.name}/${method.name}.md`,
+                    template(method)
+                );
+
+            });
+
+        });
+
+        return resolve(zip.toBuffer());
+
+    });
+
+});
+
+module.exports = plugin;

package.json

@@ -0,0 +1,40 @@
+{
+  "name": "doxdox-plugin-github-wiki",
+  "description": "GitHub wiki export plugin for doxdox.",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "adm-zip": "0.4.7",
+    "handlebars": "4.0.5"
+  },
+  "devDependencies": {
+    "@neogeek/eslint-config-standards": "1.6.4",
+    "eslint": "3.8.1"
+  },
+  "peerDependencies": {
+    "doxdox": "^1.1.x"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "doxdox",
+    "plugin",
+    "github",
+    "wiki",
+    "markdown"
+  ],
+  "authors": [
+    {
+      "name": "Scott Doxey",
+      "email": "[email protected]",
+      "homepage": "http://scottdoxey.com/"
+    }
+  ],
+  "homepage": "https://github.com/neogeek/doxdox-plugin-github-wiki",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/neogeek/doxdox-plugin-github-wiki.git"
+  }
+}

template.hbs

@@ -0,0 +1,53 @@
+# {{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}}
+
+*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*