Skip to content

Commit 3cb7732

Browse files
committed
Added markdown template.
1 parent 61bea12 commit 3cb7732

File tree

2 files changed

+28
-1
lines changed

2 files changed

+28
-1
lines changed

bin/doxdox

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ var pkg = require('../package'),
66
helpers = require('../lib/helpers')(hbs);
77

88
var templates = {
9-
bootstrap: require('../templates/bootstrap.hbs')
9+
bootstrap: require('../templates/bootstrap.hbs'),
10+
markdown: require('../templates/markdown.hbs')
1011
};
1112

1213
var title = 'Untitled Project',

templates/markdown.hbs

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
#{{title}}
2+
3+
>{{description}}
4+
5+
{{#each methods}}{{#unless ignore}}{{#if ctx}}
6+
##{{formatName ctx.string}}
7+
{{{description.summary}}}
8+
9+
###Parameters
10+
11+
{{#each tags}}{{#ifCond type "param"}}
12+
- **{{name}}** {{#each types}}`{{.}}`{{/each}} {{#if optional}}_Optional_{{/if}} {{{description}}}
13+
{{/ifCond}}{{/each}}
14+
15+
###Properties
16+
17+
{{#each tags}}{{#ifCond type "property"}}
18+
- **{{name}}** {{#each types}}`{{.}}`{{/each}} {{#if optional}}_Optional_{{/if}} {{{description}}}
19+
{{/ifCond}}{{/each}}
20+
21+
###Examples
22+
23+
{{{description.body}}}
24+
{{/if}}{{/unless}}{{/each}}
25+
26+
_Documentation generated with [doxdox](https://github.com/neogeek/doxdox)._

0 commit comments

Comments
 (0)