docgen-tool 2.1.3 → 3.0.1

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 (113) hide show
  1. package/LICENSE +35 -33
  2. package/{docgen → dist/docgen.js} +13 -24
  3. package/{source → dist/source}/docgen.js +380 -357
  4. package/dist/source/require/docgen.css +138 -0
  5. package/dist/source/require/katexInjector.js +18 -0
  6. package/dist/source/require/print.css +26 -0
  7. package/{source → dist/source}/templates/main.html +93 -93
  8. package/package.json +50 -20
  9. package/.npmignore +0 -2
  10. package/docs/advanced-content.html +0 -239
  11. package/docs/commonmark.html +0 -225
  12. package/docs/docgen.pdf +0 -0
  13. package/docs/files/images/logo.png +0 -0
  14. package/docs/files/images/overview.png +0 -0
  15. package/docs/files/images/pdf.png +0 -0
  16. package/docs/files/images/svg/icon.svg +0 -845
  17. package/docs/files/images/svg/overview.svg +0 -1345
  18. package/docs/files/images/text.png +0 -0
  19. package/docs/files/images/web.png +0 -0
  20. package/docs/index.html +0 -333
  21. package/docs/installation.html +0 -121
  22. package/docs/ownership.html +0 -164
  23. package/docs/release-notes.html +0 -148
  24. package/docs/require/docgen.css +0 -131
  25. package/docs/require/katexInjector.js +0 -22
  26. package/docs/require/print.css +0 -19
  27. package/docs/running.html +0 -123
  28. package/docs/troubleshooting.html +0 -105
  29. package/docs/upgrading.html +0 -124
  30. package/docs/version-control.html +0 -102
  31. package/docs/writing-content.html +0 -305
  32. package/index.html +0 -10
  33. package/source/example/contents.json +0 -12
  34. package/source/example/files/images/logo.png +0 -0
  35. package/source/example/index.txt +0 -4
  36. package/source/example/parameters.json +0 -37
  37. package/source/example/release-notes.txt +0 -1
  38. package/source/optional/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
  39. package/source/optional/katex/fonts/KaTeX_Main-Bold.woff +0 -0
  40. package/source/optional/katex/fonts/KaTeX_Main-Italic.woff +0 -0
  41. package/source/optional/katex/fonts/KaTeX_Main-Regular.woff +0 -0
  42. package/source/optional/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
  43. package/source/optional/katex/fonts/KaTeX_Math-Italic.woff +0 -0
  44. package/source/optional/katex/fonts/KaTeX_Math-Regular.woff +0 -0
  45. package/source/optional/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
  46. package/source/optional/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
  47. package/source/optional/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
  48. package/source/optional/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
  49. package/source/optional/katex/katex.min.css +0 -1
  50. package/source/optional/katex/katex.min.js +0 -6
  51. package/source/pdf-stylesheet.css +0 -53
  52. package/source/release-checklist.txt +0 -27
  53. package/source/require/docgen.css +0 -131
  54. package/source/require/katexInjector.js +0 -22
  55. package/source/require/print.css +0 -19
  56. package/source/require/webknife/fonts/DroidSansMono.woff +0 -0
  57. package/source/require/webknife/fonts/OpenSans.woff +0 -0
  58. package/source/require/webknife/fonts/OpenSansBold.woff +0 -0
  59. package/source/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
  60. package/source/require/webknife/fonts/OpenSansItalic.woff +0 -0
  61. package/source/require/webknife/framework.icons.js +0 -82
  62. package/source/require/webknife/framework.min.css +0 -3
  63. package/source/require/webknife/framework.min.js +0 -14
  64. package/source/require/webknife/highlight.min.css +0 -1
  65. package/source/require/webknife/highlight.min.js +0 -6
  66. package/source/user-guide/advanced-content.txt +0 -171
  67. package/source/user-guide/commonmark.txt +0 -156
  68. package/source/user-guide/contents.json +0 -57
  69. package/source/user-guide/files/images/logo.png +0 -0
  70. package/source/user-guide/files/images/overview.png +0 -0
  71. package/source/user-guide/files/images/pdf.png +0 -0
  72. package/source/user-guide/files/images/svg/icon.svg +0 -845
  73. package/source/user-guide/files/images/svg/overview.svg +0 -1345
  74. package/source/user-guide/files/images/text.png +0 -0
  75. package/source/user-guide/files/images/web.png +0 -0
  76. package/source/user-guide/index.txt +0 -245
  77. package/source/user-guide/installation.txt +0 -49
  78. package/source/user-guide/parameters.json +0 -37
  79. package/source/user-guide/release-notes.txt +0 -64
  80. package/source/user-guide/running.txt +0 -47
  81. package/source/user-guide/troubleshooting.txt +0 -32
  82. package/source/user-guide/upgrading.txt +0 -25
  83. package/source/user-guide/version-control.txt +0 -13
  84. package/source/user-guide/writing-content.txt +0 -269
  85. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
  86. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Main-Bold.woff +0 -0
  87. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Main-Italic.woff +0 -0
  88. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Main-Regular.woff +0 -0
  89. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
  90. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Math-Italic.woff +0 -0
  91. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Math-Regular.woff +0 -0
  92. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
  93. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
  94. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
  95. /package/{docs/require → dist/source/optional}/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
  96. /package/{docs/require → dist/source/optional}/katex/katex.min.css +0 -0
  97. /package/{docs/require → dist/source/optional}/katex/katex.min.js +0 -0
  98. /package/{source → dist/source}/pdf-contents.xsl +0 -0
  99. /package/{docs → dist/source}/require/webknife/fonts/DroidSansMono.woff +0 -0
  100. /package/{docs → dist/source}/require/webknife/fonts/OpenSans.woff +0 -0
  101. /package/{docs → dist/source}/require/webknife/fonts/OpenSansBold.woff +0 -0
  102. /package/{docs → dist/source}/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
  103. /package/{docs → dist/source}/require/webknife/fonts/OpenSansItalic.woff +0 -0
  104. /package/{docs → dist/source}/require/webknife/framework.icons.js +0 -0
  105. /package/{docs → dist/source}/require/webknife/framework.min.css +0 -0
  106. /package/{docs → dist/source}/require/webknife/framework.min.js +0 -0
  107. /package/{docs → dist/source}/require/webknife/highlight.min.css +0 -0
  108. /package/{docs → dist/source}/require/webknife/highlight.min.js +0 -0
  109. /package/{source → dist/source}/templates/pdfCover.html +0 -0
  110. /package/{source → dist/source}/templates/pdfFooter.html +0 -0
  111. /package/{source → dist/source}/templates/pdfHeader.html +0 -0
  112. /package/{source → dist/source}/templates/redirect.html +0 -0
  113. /package/{source → dist/source}/templates/webCover.html +0 -0
package/LICENSE CHANGED
@@ -1,33 +1,35 @@
1
- DocGen is licensed under the MIT license
2
- ----------------------------------------
3
-
4
- Copyright (c) 2015 Mark Macdonald
5
-
6
- DocGen includes third-party libraries (see below).
7
-
8
- MIT licensed:
9
- -------------
10
-
11
- KaTeX: Copyright (c) 2014 Khan Academy, (https://github.com/Khan/KaTeX)
12
-
13
- Webknife: Copyright (c) 2015 The Webknife Project, (http://mtmacdonald.github.io/webknife)
14
-
15
- Webknife includes third-party libraries attributed here: https://github.com/mtmacdonald/webknife/blob/master/LICENSE
16
-
17
- Permission is hereby granted, free of charge, to any person obtaining a copy
18
- of this software and associated documentation files (the "Software"), to deal
19
- in the Software without restriction, including without limitation the rights
20
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
21
- copies of the Software, and to permit persons to whom the Software is
22
- furnished to do so, subject to the following conditions:
23
-
24
- The above copyright notice and this permission notice shall be included in all
25
- copies or substantial portions of the Software.
26
-
27
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
30
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
31
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
32
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33
- SOFTWARE.
1
+ DocGen is licensed under the MIT license
2
+ ----------------------------------------
3
+
4
+ Copyright (c) Inkit Inc. and contributors
5
+
6
+ Lead developer and contributor Mark Macdonald
7
+
8
+ DocGen includes third-party libraries (see below).
9
+
10
+ MIT licensed:
11
+ -------------
12
+
13
+ KaTeX: Copyright (c) 2014 Khan Academy, (https://github.com/Khan/KaTeX)
14
+
15
+ Webknife: Copyright (c) 2015 The Webknife Project, (http://mtmacdonald.github.io/webknife)
16
+
17
+ Webknife includes third-party libraries attributed here: https://github.com/mtmacdonald/webknife/blob/master/LICENSE
18
+
19
+ Permission is hereby granted, free of charge, to any person obtaining a copy
20
+ of this software and associated documentation files (the "Software"), to deal
21
+ in the Software without restriction, including without limitation the rights
22
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
23
+ copies of the Software, and to permit persons to whom the Software is
24
+ furnished to do so, subject to the following conditions:
25
+
26
+ The above copyright notice and this permission notice shall be included in all
27
+ copies or substantial portions of the Software.
28
+
29
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
31
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
33
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
34
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
35
+ SOFTWARE.
@@ -1,41 +1,32 @@
1
1
  #!/usr/bin/env node
2
-
3
- var docgen = require ('./source/docgen.js');
2
+ var docgen = require('./source/docgen.js');
4
3
  var program = require('commander');
5
- var EOL = require('os').EOL;
6
-
7
4
  var generator = new docgen(process);
8
-
9
- function scaffold (command) {
5
+ var scaffold = function (command) {
10
6
  generator.setOptions(command);
11
7
  generator.scaffold();
12
- }
13
-
14
- function run (command) {
8
+ };
9
+ var run = function (command) {
15
10
  generator.setOptions(command);
16
11
  generator.run();
17
- }
18
-
12
+ };
19
13
  /*
20
14
  parse command-line arguments with node commander
21
15
  commander help: http://slides.com/timsanteford/conquering-commander-js
22
16
  command-line conventions: http://docopt.org
23
17
  */
24
-
18
+ program.version(generator.getVersion()).usage('[command] [--option]');
25
19
  program
26
- .version(generator.getVersion())
27
- .usage('[command] [--option]');
28
-
29
- program.command('scaffold')
20
+ .command('scaffold')
30
21
  .usage('[--option]')
31
22
  .description('create a template input directory')
32
23
  .option('-o, --output [path]', 'path to the output directory (default: ./)', './')
33
24
  .option('-v, --verbose', 'show verbose output including detailed errors')
34
25
  .action(function (command) {
35
- scaffold(command);
36
- })
37
-
38
- program.command('run')
26
+ scaffold(command);
27
+ });
28
+ program
29
+ .command('run')
39
30
  .usage('[--option]')
40
31
  .description('create a static website from an input directory')
41
32
  .option('-i, --input [path]', 'path to the input directory [default: ./]', './')
@@ -51,11 +42,9 @@ program.command('run')
51
42
  .option('-R, --set-release-date [date]', 'override parameters.date (useful for build tools) [default: false]', false)
52
43
  .option('-w, --wkhtmltopdf-path [path]', 'specify a custom path to wkhtmltopdf [default: wkhtmltopdf]', 'wkhtmltopdf')
53
44
  .action(function (command) {
54
- run(command);
55
- });
56
-
45
+ run(command);
46
+ });
57
47
  program.parse(process.argv);
58
-
59
48
  //if no arguments were provided, show help and then exit
60
49
  if (!process.argv.slice(2).length) {
61
50
  program.help();