Skip to content
This repository was archived by the owner on May 3, 2024. It is now read-only.

Commit f5ce969

Browse files
committed
Added test.
1 parent 5c7a161 commit f5ce969

File tree

5 files changed

+70
-0
lines changed

5 files changed

+70
-0
lines changed

.npmignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
11
.eslintrc
2+
3+
.travis.yml
4+
5+
Makefile

.travis.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
language: node_js
2+
node_js:
3+
- "4"
4+
- "5"
5+
- "6"
6+
- "7"
7+
before_install:
8+
- if [[ `npm -v` != 3* ]]; then npm i -g npm@3; fi
9+
- npm install doxdox -g
10+
after_success:
11+
- bash <(curl -s https://codecov.io/bash)
12+
sudo: false

DOCUMENTATION.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# [doxdox-plugin-markdown](https://github.com/neogeek/doxdox-plugin-markdown) *1.0.2*
2+
3+
> Markdown template plugin for doxdox.
4+
5+
6+
### index.js
7+
8+
9+
#### plugin(data)
10+
11+
Markdown template plugin for doxdox.
12+
13+
14+
15+
16+
##### Parameters
17+
18+
- **data** `Array` Methods parsed using a doxdox parser.
19+
20+
21+
22+
23+
##### Examples
24+
25+
```javascript
26+
parseInputs(inputs, {'parser': 'dox', 'layout': 'markdown'}).then(content => console.log(content));
27+
```
28+
29+
30+
##### Returns
31+
32+
33+
- `Promise` Promise with generated content.
34+
35+
36+
37+
38+
*Documentation generated with [doxdox](https://github.com/neogeek/doxdox).*

Makefile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
test:
2+
doxdox index.js --layout markdown | diff DOCUMENTATION.md -
3+
4+
fixtures:
5+
doxdox index.js --layout markdown --output DOCUMENTATION.md
6+
7+
.PHONY: test

index.js

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@ const path = require('path');
33

44
const Handlebars = require('handlebars');
55

6+
/**
7+
* Markdown template plugin for doxdox.
8+
*
9+
* @example parseInputs(inputs, {'parser': 'dox', 'layout': 'markdown'}).then(content => console.log(content));
10+
* @param {Array} data Methods parsed using a doxdox parser.
11+
* @return {Promise} Promise with generated content.
12+
* @public
13+
*/
14+
615
const plugin = data => new Promise((resolve, reject) => {
716

817
fs.readFile(path.join(__dirname, 'template.hbs'), 'utf8', (err, contents) => {

0 commit comments

Comments
 (0)