@@ -4,34 +4,57 @@ about: Create a report to help us improve
4
4
title : ' '
5
5
labels : bug
6
6
assignees : rigwild
7
-
8
7
---
9
8
10
9
## Describe the bug
10
+
11
11
A clear and concise description of what the bug is.
12
12
13
13
## Reproduce
14
+
14
15
### Usage
16
+
15
17
Used ` apidoc-markdown ` command or script.
16
18
17
19
``` bash
18
- apidoc-markdown -p ./example/basic -o ./example/basic/example.md
20
+ apidoc-markdown --debug - p ./example/basic -o ./example/basic/example.md
19
21
```
20
22
21
23
``` ts
22
24
import { generateMarkdown } from ' apidoc-markdown'
23
25
24
26
const documentation = await generateMarkdown ({
25
- apiDocProjectData: { name: ' test' , version: ' 0.13.0' , /* ... */ },
26
- apiDocApiData: [{ type: ' get' , url: ' /define' , /* ... */ }],
27
+ apiDocProjectData: { name: ' test' , version: ' 0.13.0' /* ... */ },
28
+ apiDocApiData: [{ type: ' get' , url: ' /define' /* ... */ }],
27
29
template: ' my EJS template <%= project.name %> v<%= project.version %>' ,
28
30
prepend: ' Prepend this!' ,
29
31
multi: false
30
32
})
31
33
```
32
34
35
+ ### Sample code
36
+
37
+ Some sample code to reproduce the issue.
38
+
39
+ ``` js
40
+ /**
41
+ * @api {get} /test Get a test
42
+ * @apiName GetTest
43
+ * @apiGroup Test
44
+ */
45
+ function testGet () {}
46
+
47
+ /**
48
+ * @api {post} /test Post a test
49
+ * @apiName PostTest
50
+ * @apiGroup Test
51
+ */
52
+ function testPost () {}
53
+ ```
54
+
33
55
### ` api_project.json `
34
- Used ` api_project.json ` file.
56
+
57
+ Used ` api_project.json ` file (to get this file, run your command with ` -d ` or ` --debug ` ).
35
58
36
59
``` json
37
60
{
@@ -48,10 +71,7 @@ Used `api_project.json` file.
48
71
"title" : " My own footer title" ,
49
72
"content" : " <h1>Footer .md File</h1>\n <p>Content of footer.md file.</p>\n "
50
73
},
51
- "order" : [
52
- " Markdown" ,
53
- " Example"
54
- ],
74
+ "order" : [" Markdown" , " Example" ],
55
75
"defaultVersion" : " 0.0.0" ,
56
76
"apidoc" : " 0.3.0" ,
57
77
"generator" : {
@@ -64,7 +84,8 @@ Used `api_project.json` file.
64
84
```
65
85
66
86
### ` api_data.json `
67
- Used ` api_data.json ` file.
87
+
88
+ Used ` api_data.json ` file (to get this file, run your command with ` -d ` or ` --debug ` ).
68
89
69
90
``` json
70
91
[
@@ -115,10 +136,9 @@ Used `api_data.json` file.
115
136
A clear and concise description of what you expected to happen.
116
137
117
138
** Versions (please complete the following information):**
118
- - ` Node.js ` version: ` complete_this ` [ e.g. ` 13.9.0 ` ]
119
- - ` TypeScript ` version: ` complete_this ` [ e.g. ` 13.9.0 ` ]
120
- - ` apiDoc ` version: ` complete_this ` [ e.g. ` 0.20.0 ` ]
121
- - ` apidoc-markdown ` version: ` complete_this ` [ e.g. ` 1.12.3 ` ]
139
+
140
+ - ` Node.js ` version: ` 13.9.0 `
141
+ - ` apidoc-markdown ` version: ` 1.12.3 `
122
142
123
143
** Additional context**
124
144
Add any other context about the problem here.
0 commit comments