Initial commit.

Author: neogeek

.eslintrc

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

.gitignore

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

.npmignore

@@ -0,0 +1,7 @@
+test/
+
+.eslintrc
+
+.travis.yml
+
+Makefile

.travis.yml

@@ -0,0 +1,12 @@
+language: node_js
+node_js:
+  - "4"
+  - "5"
+  - "6"
+  - "7"
+before_install:
+  - if [[ `npm -v` != 3* ]]; then npm i -g npm@3; fi
+  - npm install doxdox -g
+after_success:
+  - bash <(curl -s https://codecov.io/bash)
+sudo: false

DOCUMENTATION.md

@@ -0,0 +1,40 @@
+# [doxdox-plugin-example](https://github.com/neogeek/doxdox-plugin-example) *1.0.0*
+
+> Example template plugin for doxdox.
+
+
+### index.js
+
+
+#### plugin(data) 
+
+Example template plugin for doxdox.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| data | `Array`  | Methods parsed using a doxdox parser. |   |
+
+
+
+
+##### Examples
+
+```javascript
+parseInputs(inputs, {'parser': 'dox', 'layout': 'example'}).then(content => console.log(content));
+```
+
+
+##### Returns
+
+
+- `Promise`  Promise with generated content.
+
+
+
+
+*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*

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.

Makefile

@@ -0,0 +1,18 @@
+BIN=node_modules/.bin
+
+test:
+	make lint
+	doxdox index.js --layout markdown | diff DOCUMENTATION.md -
+	doxdox index.js --layout index.js | diff test/fixtures/documentation.html -
+
+lint:
+	$(BIN)/eslint index.js
+	$(BIN)/eslint helpers.js
+
+fixtures:
+	doxdox index.js --layout index.js --output test/fixtures/documentation.html
+
+docs:
+	doxdox index.js --layout markdown --output DOCUMENTATION.md
+
+.PHONY: test

README.md

@@ -0,0 +1,19 @@
+# doxdox-plugin-example
+
+> Example template plugin for doxdox.
+
+[![Build Status](https://travis-ci.org/neogeek/doxdox-plugin-example.svg?branch=master)](https://travis-ci.org/neogeek/doxdox-plugin-example)
+[![NPM Version](http://img.shields.io/npm/v/doxdox-plugin-example.svg?style=flat)](https://www.npmjs.org/package/doxdox-plugin-example)
+[![Latest Documentation](https://doxdox.org/images/badge-flat.svg)](https://doxdox.org/neogeek/doxdox-plugin-example)
+
+## Install
+
+```bash
+$ npm install doxdox @neogeek/doxdox-plugin-example --save-dev
+```
+
+## Usage
+
+```bash
+$ doxdox 'src/**/*.js' --layout example --output docs/index.html
+```

helpers.js

@@ -0,0 +1,36 @@
+const Handlebars = require('handlebars');
+
+const hljs = require('highlight.js');
+const markdown = require('markdown-it')({
+    highlight (code) {
+
+        return hljs.highlight('javascript', code).value;
+
+    },
+    'html': true,
+    'linkify': true
+});
+
+Handlebars.registerHelper('highlightBlock', block => {
+
+    if (block) {
+
+        return hljs.highlight('javascript', block).value;
+
+    }
+
+    return null;
+
+});
+
+Handlebars.registerHelper('markdown', block => {
+
+    if (block) {
+
+        return markdown.render(block);
+
+    }
+
+    return null;
+
+});

index.js

@@ -0,0 +1,35 @@
+const fs = require('fs');
+const path = require('path');
+
+const Handlebars = require('handlebars');
+
+require('./helpers');
+
+/**
+ * Example template plugin for doxdox.
+ *
+ * @example parseInputs(inputs, {'parser': 'dox', 'layout': 'example'}).then(content => console.log(content));
+ * @param {Array} data Methods parsed using a doxdox parser.
+ * @return {Promise} Promise with generated content.
+ * @public
+ */
+
+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;