Skip to content

Commit 9b4ba9b

Browse files
committed
readme
1 parent 97e7c76 commit 9b4ba9b

File tree

2 files changed

+0
-24
lines changed

2 files changed

+0
-24
lines changed

README.md

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
66
[![Join the chat at https://gitter.im/jsdoc2md/jsdoc2md](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jsdoc2md/jsdoc2md?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77

8-
***[Try the jsdoc2md v2 pre-release](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)***
9-
108
# jsdoc-parse
119
Transforms [jsdoc](https://github.com/jsdoc3/jsdoc) data into something more suitable for use as template input. Also adds a few tags to the default set:
1210

@@ -24,23 +22,6 @@ This module is built into [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-
2422
$ jsdoc2md --json <files>
2523
```
2624

27-
## API Reference
28-
<a name="module_jsdoc-parse"></a>
29-
30-
## jsdoc-parse
31-
**Example**
32-
```js
33-
const jsdocParse = require('jsdoc-parse')
34-
```
35-
<a name="exp_module_jsdoc-parse--jsdocParse"></a>
36-
37-
### jsdocParse(jsdocData) ⇒ <code>Array.&lt;object&gt;</code> ⏏
38-
**Kind**: Exported function
39-
**Params**
40-
41-
- jsdocData <code>Array.&lt;object&gt;</code> - jsdoc output
42-
43-
4425
* * *
4526

4627
&copy; 2014-16 Lloyd Brookes \<[email protected]\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).

jsdoc2md/README.hbs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](https://github.com/feross/standard)
66
[![Join the chat at https://gitter.im/jsdoc2md/jsdoc2md](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jsdoc2md/jsdoc2md?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
77

8-
***[Try the jsdoc2md v2 pre-release](https://github.com/jsdoc2md/jsdoc-to-markdown/releases)***
9-
108
# jsdoc-parse
119
Transforms [jsdoc](https://github.com/jsdoc3/jsdoc) data into something more suitable for use as template input. Also adds a few tags to the default set:
1210

@@ -24,9 +22,6 @@ This module is built into [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-
2422
$ jsdoc2md --json <files>
2523
```
2624

27-
## API Reference
28-
{{>main}}
29-
3025
* * *
3126

3227
&copy; 2014-16 Lloyd Brookes \<75pound@gmail.com\>. Documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown).

0 commit comments

Comments
 (0)