docgen-tool 3.0.0 → 3.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docgen.js +4 -4
- package/dist/source/docgen.js +891 -0
- package/package.json +9 -2
- package/.gitattributes +0 -1
- package/.github/workflows/deploy-website.yml +0 -28
- package/.prettierignore +0 -4
- package/.prettierrc +0 -4
- package/docgen.js +0 -95
- package/index.html +0 -10
- package/source/__test__/test-run/contents.json +0 -12
- package/source/__test__/test-run/files/images/logo.png +0 -0
- package/source/__test__/test-run/overview.txt +0 -3
- package/source/__test__/test-run/parameters.json +0 -32
- package/source/__test__/test-run/release-notes.txt +0 -4
- package/source/docgen.js +0 -988
- package/source/example/contents.json +0 -12
- package/source/example/files/images/logo.png +0 -0
- package/source/example/index.txt +0 -4
- package/source/example/parameters.json +0 -37
- package/source/example/release-notes.txt +0 -1
- package/source/internal-readme.md +0 -4
- package/source/optional/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Main-Bold.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Main-Italic.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Main-Regular.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Math-Italic.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Math-Regular.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
- package/source/optional/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
- package/source/optional/katex/katex.min.css +0 -1
- package/source/optional/katex/katex.min.js +0 -6
- package/source/pdf-contents.xsl +0 -71
- package/source/pdf-stylesheet.css +0 -59
- package/source/release-checklist.txt +0 -27
- package/source/require/docgen.css +0 -138
- package/source/require/katexInjector.js +0 -18
- package/source/require/print.css +0 -26
- package/source/require/webknife/fonts/DroidSansMono.woff +0 -0
- package/source/require/webknife/fonts/OpenSans.woff +0 -0
- package/source/require/webknife/fonts/OpenSansBold.woff +0 -0
- package/source/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
- package/source/require/webknife/fonts/OpenSansItalic.woff +0 -0
- package/source/require/webknife/framework.icons.js +0 -82
- package/source/require/webknife/framework.min.css +0 -3
- package/source/require/webknife/framework.min.js +0 -14
- package/source/require/webknife/highlight.min.css +0 -1
- package/source/require/webknife/highlight.min.js +0 -6
- package/source/templates/main.html +0 -93
- package/source/templates/pdfCover.html +0 -128
- package/source/templates/pdfFooter.html +0 -59
- package/source/templates/pdfHeader.html +0 -21
- package/source/templates/redirect.html +0 -10
- package/source/templates/webCover.html +0 -73
- package/source/user-guide/advanced-content.txt +0 -171
- package/source/user-guide/commonmark.txt +0 -156
- package/source/user-guide/contents.json +0 -57
- package/source/user-guide/files/images/logo.png +0 -0
- package/source/user-guide/files/images/overview.png +0 -0
- package/source/user-guide/files/images/pdf.png +0 -0
- package/source/user-guide/files/images/svg/icon.svg +0 -845
- package/source/user-guide/files/images/svg/inkit-logo.svg +0 -9
- package/source/user-guide/files/images/svg/overview.svg +0 -1345
- package/source/user-guide/files/images/text.png +0 -0
- package/source/user-guide/files/images/web.png +0 -0
- package/source/user-guide/index.txt +0 -258
- package/source/user-guide/installation.txt +0 -49
- package/source/user-guide/parameters.json +0 -37
- package/source/user-guide/release-notes.txt +0 -70
- package/source/user-guide/running.txt +0 -47
- package/source/user-guide/troubleshooting.txt +0 -32
- package/source/user-guide/upgrading.txt +0 -25
- package/source/user-guide/version-control.txt +0 -13
- package/source/user-guide/writing-content.txt +0 -269
- package/tsconfig.json +0 -8
|
@@ -1,156 +0,0 @@
|
|
|
1
|
-
This section shows examples of how to write content with CommonMark. See the [CommonMark Spec](http://spec.commonmark.org)
|
|
2
|
-
for more detailed information.
|
|
3
|
-
|
|
4
|
-
<style>
|
|
5
|
-
.reference pre, .reference table, .reference blockquote {
|
|
6
|
-
margin: 0;
|
|
7
|
-
}
|
|
8
|
-
.reference .codeCell pre {
|
|
9
|
-
border: none;
|
|
10
|
-
border-radius: 0;
|
|
11
|
-
}
|
|
12
|
-
.reference .codeCell {
|
|
13
|
-
padding: 0;
|
|
14
|
-
}
|
|
15
|
-
</style>
|
|
16
|
-
|
|
17
|
-
<div>
|
|
18
|
-
|
|
19
|
-
<table class="reference" style="width: 100%">
|
|
20
|
-
|
|
21
|
-
<tr><th>Element</th><th>What you type</th><th>What it looks like in DocGen</th></tr>
|
|
22
|
-
|
|
23
|
-
<tr>
|
|
24
|
-
<td class="r1">Page Heading</td>
|
|
25
|
-
<td class="codeCell"><pre><code>
|
|
26
|
-
Page Heading
|
|
27
|
-
============
|
|
28
|
-
</code></pre></td>
|
|
29
|
-
<td>
|
|
30
|
-
<p class="dg-fakeHeading" style="font-size: 20px; padding-bottom: 6px;">Page Heading</p>
|
|
31
|
-
</td>
|
|
32
|
-
</tr>
|
|
33
|
-
|
|
34
|
-
<tr>
|
|
35
|
-
<td class="r1">Section Heading</td>
|
|
36
|
-
<td class="codeCell"><pre><code>
|
|
37
|
-
Section Heading
|
|
38
|
-
---------------
|
|
39
|
-
</code></pre></td>
|
|
40
|
-
<td>
|
|
41
|
-
<p class="dg-fakeHeading" style="font-size: 18px; padding-bottom: 4px;">Section Heading</p>
|
|
42
|
-
</td>
|
|
43
|
-
</tr>
|
|
44
|
-
|
|
45
|
-
<tr>
|
|
46
|
-
<td class="r1">Minor Heading</td>
|
|
47
|
-
<td class="codeCell"><pre><code>
|
|
48
|
-
### Minor Heading
|
|
49
|
-
</code></pre></td>
|
|
50
|
-
<td>
|
|
51
|
-
<p class="dg-fakeHeading" style="font-size: 16px; padding-bottom: 4px;">Minor Heading</p>
|
|
52
|
-
</td>
|
|
53
|
-
</tr>
|
|
54
|
-
|
|
55
|
-
<tr>
|
|
56
|
-
<td class="r1">Fake Heading<br />(not in PDF contents list)</td>
|
|
57
|
-
<td class="codeCell"><pre><code>
|
|
58
|
-
<p class="dg-fakeHeading">Fake</p>
|
|
59
|
-
</code></pre></td>
|
|
60
|
-
<td>
|
|
61
|
-
<p class="dg-fakeHeading">Fake</p>
|
|
62
|
-
</td>
|
|
63
|
-
</tr>
|
|
64
|
-
|
|
65
|
-
<tr>
|
|
66
|
-
<td class="r1">Emphasis (italic)</td>
|
|
67
|
-
<td class="codeCell"><pre><code>
|
|
68
|
-
This text has *emphasis*
|
|
69
|
-
</code></pre></td>
|
|
70
|
-
<td>This text has <em>emphasis</em></td>
|
|
71
|
-
</tr>
|
|
72
|
-
|
|
73
|
-
<tr>
|
|
74
|
-
<td class="r1">Strong (bold)</td>
|
|
75
|
-
<td class="codeCell"><pre><code>
|
|
76
|
-
This text is **bold**
|
|
77
|
-
</code></pre></td>
|
|
78
|
-
<td>This text is <strong>bold</strong></td>
|
|
79
|
-
</tr>
|
|
80
|
-
|
|
81
|
-
<tr>
|
|
82
|
-
<td class="r1">Block quotes</td>
|
|
83
|
-
<td class="codeCell"><pre><code>
|
|
84
|
-
> This is a block quote.
|
|
85
|
-
</code></pre></td>
|
|
86
|
-
<td><blockquote>This is a block quote</blockquote></td>
|
|
87
|
-
</tr>
|
|
88
|
-
|
|
89
|
-
<tr>
|
|
90
|
-
<td class="r1">Code block<br/> (indent with tab)</td>
|
|
91
|
-
<td class="codeCell"><pre><code>
|
|
92
|
-
int some_code=0
|
|
93
|
-
</code></td>
|
|
94
|
-
<td><pre><code>int some_code=0;</code></pre></td>
|
|
95
|
-
</tr>
|
|
96
|
-
|
|
97
|
-
<tr>
|
|
98
|
-
<td class="r1">Unordered List</td>
|
|
99
|
-
<td class="codeCell"><pre><code>
|
|
100
|
-
* unordered list
|
|
101
|
-
* (items)
|
|
102
|
-
</code></pre></td>
|
|
103
|
-
<td><ul><li>unordered list</li><li>(items)</li></ul></td>
|
|
104
|
-
</tr>
|
|
105
|
-
|
|
106
|
-
<tr>
|
|
107
|
-
<td class="r1">Ordered List</td>
|
|
108
|
-
<td class="codeCell"><pre><code>
|
|
109
|
-
1. ordered list
|
|
110
|
-
2. (items)
|
|
111
|
-
</code></pre></td>
|
|
112
|
-
<td><ol><li>ordered list</li><li>(items)</li></ol></td>
|
|
113
|
-
</tr>
|
|
114
|
-
|
|
115
|
-
<tr>
|
|
116
|
-
<td class="r1">External Links</td>
|
|
117
|
-
<td class="codeCell"><pre><code>
|
|
118
|
-
[link](http://www.google.com)
|
|
119
|
-
</code></pre></td>
|
|
120
|
-
<td><a href="http://www.google.com">link</a></td>
|
|
121
|
-
</tr>
|
|
122
|
-
|
|
123
|
-
<tr>
|
|
124
|
-
<td class="r1">Links to a local file</td>
|
|
125
|
-
<td class="codeCell"><pre><code>
|
|
126
|
-
[attachment](user_guide.pdf)
|
|
127
|
-
</code></pre></td>
|
|
128
|
-
<td><a href="user_guide.pdf">attachment</a></td>
|
|
129
|
-
</tr>
|
|
130
|
-
|
|
131
|
-
<tr>
|
|
132
|
-
<td class="r1">Diagrams<br/> (embedding images)</td>
|
|
133
|
-
<td class="codeCell"><pre><code>
|
|
134
|
-

|
|
135
|
-
</code></pre></td>
|
|
136
|
-
<td><img src="files/images/logo.png"></td>
|
|
137
|
-
</tr>
|
|
138
|
-
|
|
139
|
-
<tr>
|
|
140
|
-
<td class="r1">Simple table</td>
|
|
141
|
-
<td class="codeCell"><pre><code>
|
|
142
|
-
| Cell 1 | Cell 2 | Cell 3 |
|
|
143
|
-
| Cell 4 | Cell 5 | Cell 6 |
|
|
144
|
-
</code></pre></td>
|
|
145
|
-
<td>
|
|
146
|
-
|
|
147
|
-
<table style="width:300px;">
|
|
148
|
-
<tr><td>Cell 1</td><td>Cell 2</td><td>Cell 3</td></tr>
|
|
149
|
-
<tr><td>Cell 4</td><td>Cell 5</td><td>Cell 6</td></tr>
|
|
150
|
-
</table>
|
|
151
|
-
|
|
152
|
-
</td>
|
|
153
|
-
</tr>
|
|
154
|
-
|
|
155
|
-
</table>
|
|
156
|
-
</div>
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
[
|
|
2
|
-
{
|
|
3
|
-
"heading": "Quick Start",
|
|
4
|
-
"column": 1,
|
|
5
|
-
"pages": [
|
|
6
|
-
{
|
|
7
|
-
"title": "Overview",
|
|
8
|
-
"source": "index.txt",
|
|
9
|
-
"html": true
|
|
10
|
-
},
|
|
11
|
-
{
|
|
12
|
-
"title": "Installation",
|
|
13
|
-
"source": "installation.txt"
|
|
14
|
-
},
|
|
15
|
-
{
|
|
16
|
-
"title": "Upgrading",
|
|
17
|
-
"source": "upgrading.txt"
|
|
18
|
-
}
|
|
19
|
-
]
|
|
20
|
-
},
|
|
21
|
-
{
|
|
22
|
-
"heading": "User Guide",
|
|
23
|
-
"column": 2,
|
|
24
|
-
"pages": [
|
|
25
|
-
{
|
|
26
|
-
"title": "Running DocGen",
|
|
27
|
-
"source": "running.txt"
|
|
28
|
-
},
|
|
29
|
-
{
|
|
30
|
-
"title": "Writing content",
|
|
31
|
-
"source": "writing-content.txt"
|
|
32
|
-
},
|
|
33
|
-
{
|
|
34
|
-
"title": "CommonMark reference",
|
|
35
|
-
"source": "commonmark.txt"
|
|
36
|
-
},
|
|
37
|
-
{
|
|
38
|
-
"title": "Advanced content",
|
|
39
|
-
"source": "advanced-content.txt"
|
|
40
|
-
}
|
|
41
|
-
]
|
|
42
|
-
},
|
|
43
|
-
{
|
|
44
|
-
"heading": "Help",
|
|
45
|
-
"column": 3,
|
|
46
|
-
"pages": [
|
|
47
|
-
{
|
|
48
|
-
"title": "Troubleshooting",
|
|
49
|
-
"source": "troubleshooting.txt"
|
|
50
|
-
},
|
|
51
|
-
{
|
|
52
|
-
"title": "Using with version control",
|
|
53
|
-
"source": "version-control.txt"
|
|
54
|
-
}
|
|
55
|
-
]
|
|
56
|
-
}
|
|
57
|
-
]
|
|
Binary file
|
|
Binary file
|
|
Binary file
|