docgen-tool 2.1.3 → 3.0.0

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 (81) hide show
  1. package/.gitattributes +1 -0
  2. package/.github/workflows/deploy-website.yml +28 -0
  3. package/.prettierignore +4 -0
  4. package/.prettierrc +4 -0
  5. package/LICENSE +35 -33
  6. package/{docgen → dist/docgen.js} +11 -22
  7. package/docgen.js +95 -0
  8. package/package.json +47 -20
  9. package/source/__test__/test-run/contents.json +12 -0
  10. package/source/__test__/test-run/overview.txt +3 -0
  11. package/source/__test__/test-run/parameters.json +32 -0
  12. package/source/__test__/test-run/release-notes.txt +4 -0
  13. package/source/docgen.js +896 -776
  14. package/source/example/contents.json +11 -11
  15. package/source/example/index.txt +3 -3
  16. package/source/example/parameters.json +36 -36
  17. package/source/internal-readme.md +4 -0
  18. package/source/pdf-stylesheet.css +26 -20
  19. package/source/require/docgen.css +76 -69
  20. package/source/require/katexInjector.js +9 -13
  21. package/source/require/print.css +26 -19
  22. package/source/templates/main.html +93 -93
  23. package/source/user-guide/advanced-content.txt +170 -170
  24. package/source/user-guide/contents.json +56 -56
  25. package/source/user-guide/files/images/svg/inkit-logo.svg +9 -0
  26. package/source/user-guide/index.txt +257 -244
  27. package/source/user-guide/installation.txt +49 -49
  28. package/source/user-guide/parameters.json +36 -36
  29. package/source/user-guide/release-notes.txt +69 -63
  30. package/source/user-guide/running.txt +46 -46
  31. package/source/user-guide/troubleshooting.txt +31 -31
  32. package/source/user-guide/upgrading.txt +25 -25
  33. package/source/user-guide/version-control.txt +13 -13
  34. package/source/user-guide/writing-content.txt +269 -269
  35. package/tsconfig.json +8 -0
  36. package/.npmignore +0 -2
  37. package/docs/advanced-content.html +0 -239
  38. package/docs/commonmark.html +0 -225
  39. package/docs/docgen.pdf +0 -0
  40. package/docs/files/images/overview.png +0 -0
  41. package/docs/files/images/pdf.png +0 -0
  42. package/docs/files/images/svg/icon.svg +0 -845
  43. package/docs/files/images/svg/overview.svg +0 -1345
  44. package/docs/files/images/text.png +0 -0
  45. package/docs/files/images/web.png +0 -0
  46. package/docs/index.html +0 -333
  47. package/docs/installation.html +0 -121
  48. package/docs/ownership.html +0 -164
  49. package/docs/release-notes.html +0 -148
  50. package/docs/require/docgen.css +0 -131
  51. package/docs/require/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
  52. package/docs/require/katex/fonts/KaTeX_Main-Bold.woff +0 -0
  53. package/docs/require/katex/fonts/KaTeX_Main-Italic.woff +0 -0
  54. package/docs/require/katex/fonts/KaTeX_Main-Regular.woff +0 -0
  55. package/docs/require/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
  56. package/docs/require/katex/fonts/KaTeX_Math-Italic.woff +0 -0
  57. package/docs/require/katex/fonts/KaTeX_Math-Regular.woff +0 -0
  58. package/docs/require/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
  59. package/docs/require/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
  60. package/docs/require/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
  61. package/docs/require/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
  62. package/docs/require/katex/katex.min.css +0 -1
  63. package/docs/require/katex/katex.min.js +0 -6
  64. package/docs/require/katexInjector.js +0 -22
  65. package/docs/require/print.css +0 -19
  66. package/docs/require/webknife/fonts/DroidSansMono.woff +0 -0
  67. package/docs/require/webknife/fonts/OpenSans.woff +0 -0
  68. package/docs/require/webknife/fonts/OpenSansBold.woff +0 -0
  69. package/docs/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
  70. package/docs/require/webknife/fonts/OpenSansItalic.woff +0 -0
  71. package/docs/require/webknife/framework.icons.js +0 -82
  72. package/docs/require/webknife/framework.min.css +0 -3
  73. package/docs/require/webknife/framework.min.js +0 -14
  74. package/docs/require/webknife/highlight.min.css +0 -1
  75. package/docs/require/webknife/highlight.min.js +0 -6
  76. package/docs/running.html +0 -123
  77. package/docs/troubleshooting.html +0 -105
  78. package/docs/upgrading.html +0 -124
  79. package/docs/version-control.html +0 -102
  80. package/docs/writing-content.html +0 -305
  81. /package/{docs → source/__test__/test-run}/files/images/logo.png +0 -0
package/source/example/contents.json CHANGED
@@ -1,12 +1,12 @@
1
1
  [
2
- {
3
- "heading" : "Quick Start",
4
- "column" : 1,
5
- "pages" : [
6
- {
7
- "title": "Overview",
8
- "source": "index.txt"
9
- }
10
- ]
11
- }
12
- ]
2
+ {
3
+ "heading": "Quick Start",
4
+ "column": 1,
5
+ "pages": [
6
+ {
7
+ "title": "Overview",
8
+ "source": "index.txt"
9
+ }
10
+ ]
11
+ }
12
+ ]
package/source/example/index.txt CHANGED
@@ -1,4 +1,4 @@
1
- This is the empty template page for DocGen.
2
-
3
- To get started, edit **index.txt** and run DocGen. For more help see the
1
+ This is the empty template page for DocGen.
2
+
3
+ To get started, edit **index.txt** and run DocGen. For more help see the
4
4
  [user guide](http://mtmacdonald.github.io/docgen/).
package/source/example/parameters.json CHANGED
@@ -1,37 +1,37 @@
1
1
  {
2
- "title" : "DocGen - empty template",
3
- "name": "",
4
- "version" : "1.0.0",
5
- "date" : "XX/XX/XXXX",
6
- "organization" : {
7
- "name" : "",
8
- "url" : ""
9
- },
10
- "author" : {
11
- "name" : "",
12
- "url" : ""
13
- },
14
- "owner" : {
15
- "name" : "",
16
- "url" : ""
17
- },
18
- "contributors" : [
19
- {
20
- "name" : "",
21
- "url" : ""
22
- }
23
- ],
24
- "website" : {
25
- "name" : "",
26
- "url" : ""
27
- },
28
- "backlink" : {
29
- "name" : "",
30
- "url" : ""
31
- },
32
- "module" : "",
33
- "id" : "",
34
- "summary" : "",
35
- "marking" : "",
36
- "legalese" : ""
37
- }
2
+ "title": "DocGen - empty template",
3
+ "name": "Template",
4
+ "version": "1.0.0",
5
+ "date": "XX/XX/XXXX",
6
+ "organization": {
7
+ "name": "",
8
+ "url": ""
9
+ },
10
+ "author": {
11
+ "name": "",
12
+ "url": ""
13
+ },
14
+ "owner": {
15
+ "name": "",
16
+ "url": ""
17
+ },
18
+ "contributors": [
19
+ {
20
+ "name": "",
21
+ "url": ""
22
+ }
23
+ ],
24
+ "website": {
25
+ "name": "",
26
+ "url": ""
27
+ },
28
+ "backlink": {
29
+ "name": "",
30
+ "url": ""
31
+ },
32
+ "module": "",
33
+ "id": "",
34
+ "summary": "",
35
+ "marking": "",
36
+ "legalese": ""
37
+ }
package/source/internal-readme.md ADDED
@@ -0,0 +1,4 @@
1
+ To regenerate the docs site:
2
+
3
+ ./docgen run -i ./source/user-guide -o ./docs -p -m -n -d 30000
4
+