Skip to content

Commit 50509ba

Browse files
committed
Add docs for signature template
1 parent b4eea7a commit 50509ba

File tree

2 files changed

+27
-1
lines changed

2 files changed

+27
-1
lines changed

bit-docs.js

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@ var processJavaScript = require("./process/javascript");
33
var path = require("path");
44

55
/**
6-
* @module {function} bit-docs-js
76
* @parent plugins
7+
* @module {function} bit-docs-js
88
* @group bit-docs-js/tags tags
9+
* @group bit-docs-js/templates templates
910
*
1011
* @description Tags, templates, and basic styles for JavaScript.
1112
*

templates/signature.mustache.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
@parent bit-docs-js/templates
2+
@page bit-docs-js/templates/signature signature
3+
4+
@description The function signature template.
5+
6+
@body
7+
8+
The `signature.mustache` template outputs a function signature.
9+
10+
For tips on adding this template to your custom theme, see
11+
[bit-docs-generate-html/theme/templates/content].
12+
13+
You can use the following snippet:
14+
15+
```
16+
{{#if signatures}}
17+
{{#each signatures}}
18+
{{> signature.mustache}}
19+
{{/each}}
20+
{{else}}
21+
{{#types}}
22+
{{> signature.mustache}}
23+
{{/types}}
24+
{{/if}}
25+
```

0 commit comments

Comments
 (0)