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.
Files changed (77) hide show
  1. package/dist/docgen.js +4 -4
  2. package/dist/source/docgen.js +891 -0
  3. package/package.json +9 -2
  4. package/.gitattributes +0 -1
  5. package/.github/workflows/deploy-website.yml +0 -28
  6. package/.prettierignore +0 -4
  7. package/.prettierrc +0 -4
  8. package/docgen.js +0 -95
  9. package/index.html +0 -10
  10. package/source/__test__/test-run/contents.json +0 -12
  11. package/source/__test__/test-run/files/images/logo.png +0 -0
  12. package/source/__test__/test-run/overview.txt +0 -3
  13. package/source/__test__/test-run/parameters.json +0 -32
  14. package/source/__test__/test-run/release-notes.txt +0 -4
  15. package/source/docgen.js +0 -988
  16. package/source/example/contents.json +0 -12
  17. package/source/example/files/images/logo.png +0 -0
  18. package/source/example/index.txt +0 -4
  19. package/source/example/parameters.json +0 -37
  20. package/source/example/release-notes.txt +0 -1
  21. package/source/internal-readme.md +0 -4
  22. package/source/optional/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
  23. package/source/optional/katex/fonts/KaTeX_Main-Bold.woff +0 -0
  24. package/source/optional/katex/fonts/KaTeX_Main-Italic.woff +0 -0
  25. package/source/optional/katex/fonts/KaTeX_Main-Regular.woff +0 -0
  26. package/source/optional/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
  27. package/source/optional/katex/fonts/KaTeX_Math-Italic.woff +0 -0
  28. package/source/optional/katex/fonts/KaTeX_Math-Regular.woff +0 -0
  29. package/source/optional/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
  30. package/source/optional/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
  31. package/source/optional/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
  32. package/source/optional/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
  33. package/source/optional/katex/katex.min.css +0 -1
  34. package/source/optional/katex/katex.min.js +0 -6
  35. package/source/pdf-contents.xsl +0 -71
  36. package/source/pdf-stylesheet.css +0 -59
  37. package/source/release-checklist.txt +0 -27
  38. package/source/require/docgen.css +0 -138
  39. package/source/require/katexInjector.js +0 -18
  40. package/source/require/print.css +0 -26
  41. package/source/require/webknife/fonts/DroidSansMono.woff +0 -0
  42. package/source/require/webknife/fonts/OpenSans.woff +0 -0
  43. package/source/require/webknife/fonts/OpenSansBold.woff +0 -0
  44. package/source/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
  45. package/source/require/webknife/fonts/OpenSansItalic.woff +0 -0
  46. package/source/require/webknife/framework.icons.js +0 -82
  47. package/source/require/webknife/framework.min.css +0 -3
  48. package/source/require/webknife/framework.min.js +0 -14
  49. package/source/require/webknife/highlight.min.css +0 -1
  50. package/source/require/webknife/highlight.min.js +0 -6
  51. package/source/templates/main.html +0 -93
  52. package/source/templates/pdfCover.html +0 -128
  53. package/source/templates/pdfFooter.html +0 -59
  54. package/source/templates/pdfHeader.html +0 -21
  55. package/source/templates/redirect.html +0 -10
  56. package/source/templates/webCover.html +0 -73
  57. package/source/user-guide/advanced-content.txt +0 -171
  58. package/source/user-guide/commonmark.txt +0 -156
  59. package/source/user-guide/contents.json +0 -57
  60. package/source/user-guide/files/images/logo.png +0 -0
  61. package/source/user-guide/files/images/overview.png +0 -0
  62. package/source/user-guide/files/images/pdf.png +0 -0
  63. package/source/user-guide/files/images/svg/icon.svg +0 -845
  64. package/source/user-guide/files/images/svg/inkit-logo.svg +0 -9
  65. package/source/user-guide/files/images/svg/overview.svg +0 -1345
  66. package/source/user-guide/files/images/text.png +0 -0
  67. package/source/user-guide/files/images/web.png +0 -0
  68. package/source/user-guide/index.txt +0 -258
  69. package/source/user-guide/installation.txt +0 -49
  70. package/source/user-guide/parameters.json +0 -37
  71. package/source/user-guide/release-notes.txt +0 -70
  72. package/source/user-guide/running.txt +0 -47
  73. package/source/user-guide/troubleshooting.txt +0 -32
  74. package/source/user-guide/upgrading.txt +0 -25
  75. package/source/user-guide/version-control.txt +0 -13
  76. package/source/user-guide/writing-content.txt +0 -269
  77. package/tsconfig.json +0 -8
@@ -1,93 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
- <meta http-equiv="X-UA-Compatible" content="IE=edge" ><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
5
- <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
6
- <meta charset="UTF-8">
7
- <title></title>
8
-
9
- <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
10
- <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css" />
11
- <link rel="stylesheet" href="require/webknife/highlight.min.css" type="text/css" />
12
- <link rel="stylesheet" href="require/docgen.css" type="text/css" />
13
- <link rel="stylesheet" href="require/print.css" media="print" />
14
-
15
- <!--load scripts second-->
16
-
17
- <script src="require/webknife/framework.min.js"></script>
18
- <script src="require/webknife/framework.icons.js"></script>
19
- <script src="require/webknife/highlight.min.js"></script>
20
-
21
- <!--inline scripts last-->
22
-
23
- <script type="text/javascript">
24
-
25
- $(document).ready( function () {
26
- $("#dg-toc").hide(); //hide the table of contents
27
-
28
- //instantiate an svg injector to show SVG icons
29
- var injector = new svgInject();
30
- injector.inject();
31
-
32
- //code syntax highlighting
33
- $('pre code, .w-inline-code').each(function(i, block) {
34
- hljs.highlightBlock(block);
35
- });
36
-
37
- //toggle visibility of table of contents
38
- $("#dg-navigator").click(function()
39
- {
40
- $("#dg-toc").slideToggle("fast");
41
- $(this).toggleClass("active");
42
- });
43
-
44
- });
45
- </script>
46
-
47
- <script type="text/x-mathjax-config">
48
- //MathJax configuration is the same as used by math.stackexchange.com
49
- MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX","TeX"], linebreaks: { automatic:true }, EqnChunk: (MathJax.Hub.Browser.isMobile ? 10 : 50) },
50
- tex2jax: { inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, ignoreClass: "tex2jax_ignore|dno" },
51
- TeX: { noUndefined: { attributes: { mathcolor: "red", mathbackground: "#FFEEEE", mathsize: "90%" } }, Macros: { href: "{}" } },
52
- messageStyle: "none"
53
- });
54
- </script>
55
-
56
- </head>
57
-
58
- <body>
59
-
60
- <div id="dg-toc"></div>
61
- <div id="dg-navigator">Table of contents</div>
62
-
63
- <header>
64
- <div class="w-fixed-width">
65
- <a id="dg-homelink" href="">
66
- <div id="dg-logo">
67
- <span id="dg-title"></span> <span id="dg-web-title-version" style="font-weight:normal;"></span>
68
- </div>
69
- </a>
70
- <div>
71
- <span id="dg-backlink"></span>
72
- </div>
73
- </div>
74
- </header>
75
-
76
- <section id="dg-content">
77
-
78
- </section>
79
-
80
- <footer>
81
- <div><p class="w-fixed-width"><span id="dg-web-footer">.</p></div>
82
- <div class="w-fixed-width">
83
- <p><span id="dg-copyright"></span></p>
84
- <p>
85
- <span id="dg-marking"></span>
86
- <span id="dg-legalese"></span>
87
- <span id="dg-attribution"></span>
88
- </p>
89
- </div>
90
- </footer>
91
-
92
- </body>
93
- </html>
@@ -1,128 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
- <meta http-equiv="X-UA-Compatible" content="IE=edge" ><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
5
- <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
6
- <meta charset="UTF-8">
7
- <title>DocGen</title>
8
-
9
- <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
10
- <link rel="stylesheet" href="../require/webknife/framework.min.css" type="text/css" />
11
- <link rel="stylesheet" href="../require/docgen.css" type="text/css" />
12
- <link rel="stylesheet" href="../require/print.css" media="print" />
13
-
14
- <style>
15
-
16
- html {
17
- background: none;
18
- min-height: 100%;
19
- }
20
-
21
- #dg-pdfLogo {
22
- display: inline-block;
23
- float: right;
24
-
25
- }
26
-
27
- #dg-coverInfo {
28
- margin-top: 100px;
29
- margin-bottom: 50px;
30
- width: 100%;
31
- }
32
-
33
- #dg-coverInfo {
34
- border-collapse: separate; /*http://stackoverflow.com/questions/7625586/*/
35
- }
36
-
37
- #dg-coverInfo th {
38
- background-color: #385691;
39
- color: white;
40
- font-size: 34px;
41
- padding: 20px;
42
- border: 1px solid #385691;
43
- border-radius: 10px 10px 0 0;
44
- }
45
-
46
- #dg-coverInfo tr td {
47
- border-top: 2px solid #385691;
48
- border-left: 2px solid #385691;
49
- border-bottom: none;
50
- border-right: none;
51
- padding-top: 20px;
52
- padding-bottom: 20px;
53
- }
54
-
55
- #dg-coverInfo td:last-child {
56
- border-right: 2px solid #385691;
57
- }
58
-
59
- #dg-coverInfo .dg-finalRow td {
60
- border-bottom: 2px solid #385691;
61
- }
62
-
63
- #dg-summary {
64
- margin-bottom: 100px;
65
- }
66
-
67
- #dg-footer {
68
- /*position: fixed;*/
69
- /*bottom: 0px;*/
70
- width: 100%;
71
- text-align: center;
72
- }
73
-
74
- #footnote {
75
- font-size: 9px;
76
- }
77
-
78
-
79
- </style>
80
-
81
- <script src="../require/webknife/framework.min.js"></script>
82
-
83
- </head>
84
- <body>
85
-
86
- <div class="w-clear-after"><div id="dg-pdfLogo"><img src="../files/images/logo.png" /></div></div>
87
-
88
- <table class="w-table w-fixed" id="dg-coverInfo">
89
- <thead>
90
- <tr>
91
- <th colspan="3" id="dg-title"></th>
92
- </tr>
93
- </thead>
94
- <tfoot>
95
- </tfoot>
96
- <tbody>
97
- <tr>
98
- <td><strong>Owner: </strong> <span id="dg-owner"></span></td>
99
- <td><strong>Version: </strong> <span id="dg-version"></span></td>
100
- <td><strong>Released: </strong> <span id="dg-release-date"></span></td>
101
- </tr>
102
- <tr>
103
- <td><strong>Author: </strong> <span id="dg-author"></span></td>
104
- <td colspan="2"><strong>Contributors: </strong> <span id="dg-contributors"></span></td>
105
- </tr>
106
- <tr class="dg-finalRow">
107
- <td><strong>Module: </strong> <span id="dg-module"></span></td>
108
- <td><strong>ID: </strong> <span id="dg-id"></span></td>
109
- <td><strong>Link: </strong> <span id="dg-website"></span></td>
110
- </tr>
111
- <tr>
112
- </tbody>
113
- </table>
114
-
115
- <h1>Summary</h1>
116
- <p id="dg-summary"></p>
117
-
118
- <div id="dg-footer">
119
- <p><span id="dg-copyright"></span></p>
120
- <p id="footnote">
121
- <span id="dg-marking"></span>
122
- <span id="dg-legalese"></span>
123
- <span id="dg-attribution"></span>
124
- </p>
125
- </div>
126
-
127
- </body>
128
- </html>
@@ -1,59 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
-
5
- <link rel="stylesheet" href="../require/webknife/framework.min.css" type="text/css" />
6
- <link rel="stylesheet" href="../require/docgen.css" type="text/css" />
7
- <link rel="stylesheet" href="../require/print.css" media="print" />
8
-
9
- <style>
10
-
11
- #dg-footer {
12
- border-top: 1px solid #385691;
13
- padding-top: 10px;
14
- }
15
-
16
- #dg-footer table {
17
- width: 100%;
18
- text-align: center;
19
- table-layout: fixed;
20
- word-wrap: break-word;
21
- }
22
-
23
- a {
24
- text-decoration: none;
25
- color: #444;
26
- }
27
-
28
- </style>
29
-
30
- <script> /*from wkhtmltopdf documenation - substitutes in parameters like page numbers at runtime*/
31
- function subst() {
32
- var vars={};
33
- var x=document.location.search.substring(1).split('&');
34
- for(var i in x) {var z=x[i].split('=',2);vars[z[0]] = unescape(z[1]);}
35
- var x=['frompage','topage','page','webpage','section','subsection','subsubsection'];
36
- for(var i in x) {
37
- var y = document.getElementsByClassName(x[i]);
38
- for(var j=0; j<y.length; ++j) y[j].textContent = vars[x[i]];
39
- }
40
- }
41
- </script>
42
-
43
- </head>
44
- <body onload="subst()">
45
-
46
- <div id="dg-footer">
47
- <table><thead></thead><tfoot></tfoot><tbody>
48
- <tr>
49
- <td><span id="dg-title"></span> <span id="dg-web-title-version"></span></td>
50
- <td><span id="dg-copyright"></td>
51
- <td>Page <span class="page"></span> of <span class="topage"></span></td>
52
- </tr>
53
- </tbody></table>
54
- </div>
55
-
56
- </body>
57
- </html>
58
-
59
-
@@ -1,21 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
-
5
- <link rel="stylesheet" href="../require/webknife/framework.min.css" type="text/css" />
6
- <link rel="stylesheet" href="../require/docgen.css" type="text/css" />
7
- <link rel="stylesheet" href="../require/print.css" media="print" />
8
-
9
- <style>
10
- #dg-header {
11
- text-align:right;
12
- }
13
-
14
- </style>
15
- </head>
16
- <body>
17
- <div id="dg-header">
18
- <img src="../files/images/logo.png" />
19
- </div>
20
- </body>
21
- </html>
@@ -1,10 +0,0 @@
1
- <!doctype html>
2
- <html>
3
- <head>
4
- <title></title>
5
- <meta http-equiv="REFRESH" content="0;url=docs/index.html">
6
- </head>
7
- <body>
8
- <a href="docs/index.html" style="color:#ccc;font-size:12px">Redirect to homepage</a>
9
- </body>
10
- </html>
@@ -1,73 +0,0 @@
1
- <style>
2
-
3
- #dg-coverInfo {
4
- margin-top: 100px;
5
- margin-bottom: 50px;
6
- width: 100%;
7
- }
8
-
9
- #dg-coverInfo {
10
- border-collapse: separate; /*http://stackoverflow.com/questions/7625586/*/
11
- }
12
-
13
- #dg-coverInfo th {
14
- background-color: #385691;
15
- color: white;
16
- font-size: 34px;
17
- padding: 20px;
18
- border: 1px solid #385691;
19
- border-radius: 10px 10px 0 0;
20
- }
21
-
22
- #dg-coverInfo tr td {
23
- border-top: 2px solid #385691;
24
- border-left: 2px solid #385691;
25
- border-bottom: none;
26
- border-right: none;
27
- padding-top: 20px;
28
- padding-bottom: 20px;
29
- }
30
-
31
- #dg-coverInfo td:last-child {
32
- border-right: 2px solid #385691;
33
- }
34
-
35
- #dg-coverInfo .dg-finalRow td {
36
- border-bottom: 2px solid #385691;
37
- }
38
-
39
- #dg-summary {
40
- margin-bottom: 100px;
41
- }
42
-
43
- </style>
44
-
45
- <table class="w-table w-fixed" id="dg-coverInfo">
46
- <thead>
47
- <tr>
48
- <th colspan="3" id="dg-title"></th>
49
- </tr>
50
- </thead>
51
- <tfoot>
52
- </tfoot>
53
- <tbody>
54
- <tr>
55
- <td><strong>Owner: </strong> <span id="dg-owner"></span></td>
56
- <td><strong>Version: </strong> <span id="dg-version"></span></td>
57
- <td><strong>Released: </strong> <span id="dg-release-date"></span></td>
58
- </tr>
59
- <tr>
60
- <td><strong>Author: </strong> <span id="dg-author"></span></td>
61
- <td colspan="2"><strong>Contributors: </strong> <span id="dg-contributors"></span></td>
62
- </tr>
63
- <tr class="dg-finalRow">
64
- <td><strong>Module: </strong> <span id="dg-module"></span></td>
65
- <td><strong>ID: </strong> <span id="dg-id"></span></td>
66
- <td><strong>Link: </strong> <span id="dg-website"></span></td>
67
- </tr>
68
- <tr>
69
- </tbody>
70
- </table>
71
-
72
- <h1>Summary</h1>
73
- <p id="dg-summary"></p>
@@ -1,171 +0,0 @@
1
- <style>
2
- .container {
3
- box-sizing: border-box;
4
- float:left;
5
- width: 480px;
6
- }
7
- .codeContainer {
8
- margin: 0 20px 0 0;
9
- }
10
- .codeContainer pre {
11
- margin: 0;
12
- }
13
- .codeContainer code {
14
- }
15
- .codeContainer p {
16
- margin: 0;
17
- padding: 0;
18
- }
19
- .exampleContainer {
20
- margin: 0;
21
- border: 1px solid #666;
22
- border-radius: 6px;
23
- padding: 0 18px 0 18px;
24
- }
25
- .exampleContainer img {
26
- margin-top: 5px;
27
- }
28
- #content table {
29
- width: 400px!important;
30
- }
31
- .hljs-change {
32
- background-color: initial!important;
33
- }
34
- </style>
35
-
36
- Advanced styles
37
- ---------------
38
-
39
- DocGen is built on the [Webknife CSS framework](http://mtmacdonald.github.io/webknife). Any of the HTML elements and
40
- styles from Webknife can be used in a DocGen source file. For details, see
41
- the [Webknife reference guide](http://mtmacdonald.github.io/webknife/docs/reference.html).
42
-
43
- Basic tables
44
- ------------
45
-
46
- Basic tables can be inserted with the Github-flavoured Markdown
47
- [table extension](https://help.github.com/articles/github-flavored-markdown/#tables).
48
-
49
- <div class="container codeContainer">
50
- <pre><code>| Heading | Heading | Heading |
51
- |:-----------:----------:|--------:|
52
- | Something | Something | ? |
53
- | Another | Another | ? |
54
- | One more | One more | ? |</code></pre>
55
- </div>
56
- <div class="container exampleContainer">
57
- <table class="w-table w-fixed w-stripe">
58
- <thead>
59
- <tr>
60
- <th style="text-align:left">Heading</th>
61
- <th style="text-align:center">Heading</th>
62
- <th style="text-align:right">Heading</th>
63
- </tr>
64
- </thead>
65
- <tbody>
66
- <tr>
67
- <td style="text-align:left">Something</td>
68
- <td style="text-align:center">Something</td>
69
- <td style="text-align:right">?</td>
70
- </tr>
71
- <tr>
72
- <td style="text-align:left">Another</td>
73
- <td style="text-align:center">Another</td>
74
- <td style="text-align:right">?</td>
75
- </tr>
76
- <tr>
77
- <td style="text-align:left">One more</td>
78
- <td style="text-align:center">One more</td>
79
- <td style="text-align:right">?</td>
80
- </tr>
81
- </tbody>
82
- </table>
83
- </div><br class="w-clear"/>
84
-
85
- HTML tables
86
- -----------
87
-
88
- Regular HTML can also be used for tables, allowing full custom styling (including table and column widths).
89
-
90
- <div class="container codeContainer">
91
- <pre><code>&lt;table style=&quot;width:100%;&quot;&gt;
92
- &lt;tr&gt;
93
- &lt;th&gt;Heading&lt;/th&gt;
94
- &lt;th&gt;Heading&lt;/th&gt;
95
- &lt;th&gt;Heading&lt;/th&gt;
96
- &lt;/tr&gt;
97
- &lt;tr&gt;
98
- &lt;td class=&quot;bold&quot;&gt;Example&lt;/td&gt;
99
- &lt;td&gt;Example&lt;/td&gt;
100
- &lt;td&gt;Example&lt;/td&gt;
101
- &lt;/tr&gt;
102
- &lt;tr&gt;
103
- &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
104
- &lt;td class=&quot;w-success-text&quot;&gt;Example&lt;/td&gt;
105
- &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;checkmark&quot;&gt;&lt;/span&gt;&lt;/td&gt;
106
- &lt;/tr&gt;
107
- &lt;tr&gt;
108
- &lt;td&gt;&lt;strong&gt;Example&lt;/strong&gt;&lt;/td&gt;
109
- &lt;td class=&quot;w-error-text&quot;&gt;Example&lt;/td&gt;
110
- &lt;td&gt;&lt;span class=&quot;w-icon&quot; data-name=&quot;close&quot;&gt;&lt;/td&gt;
111
- &lt;/tr&gt;
112
- &lt;/table&gt;</code></pre>
113
- </div>
114
- <div class="container exampleContainer">
115
- <table style="width:100%;">
116
- <tr>
117
- <th>Heading</th>
118
- <th>Heading</th>
119
- <th>Heading</th>
120
- </tr>
121
- <tr>
122
- <td class="bold">Example</td>
123
- <td>Example</td>
124
- <td>Example</td>
125
- </tr>
126
- <tr>
127
- <td><strong>Example</strong></td>
128
- <td class="w-success-text">Example</td>
129
- <td><span class="w-icon" data-name="checkmark"></span></td>
130
- </tr>
131
- <tr>
132
- <td><strong>Example</strong></td>
133
- <td class="w-error-text">Example</td>
134
- <td><span class="w-icon" data-name="close"></td>
135
- </tr>
136
- </table>
137
- </div><br class="w-clear"/>
138
-
139
- Creating internal links to page sections
140
- ----------------------------------------
141
-
142
- To create links to other sections within one content page, put hyphens between the words in the heading and prepend with #:
143
-
144
- [link to heading](#this-is-a-heading)
145
-
146
- ... other page content here ...
147
-
148
- This is a heading
149
- -----------------
150
-
151
- Creating internal links to other pages
152
- --------------------------------------
153
-
154
- To create links to *other* content pages provide the relative url to the page:
155
-
156
- [link to heading](example-page.html)
157
-
158
- Control of page breaks in the PDF
159
- ---------------------------------
160
-
161
- DocGen does not provide precision control over PDF layout. However, some steps can be taken in case of page break
162
- issues (the most common problem).
163
-
164
- To *force* a page break, insert the following before an element that should appear on a new page:
165
-
166
- <p class="dg-forceBreak"></p>
167
-
168
- DocGen automatically tries to eliminate page breaks *inside* code blocks, block quotes, and table rows.
169
- To apply the same technique to other elements, revert to HTML and apply the **dg-avoidBreak** class. For example:
170
-
171
- <p class="dg-avoidBreak">A long paragraph</p>