docgen-tool 3.0.0 → 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 (77) hide show
  1. package/dist/docgen.js +4 -4
  2. package/dist/source/docgen.js +891 -0
  3. package/package.json +4 -1
  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/pdf-stylesheet.css +0 -59
  23. package/source/release-checklist.txt +0 -27
  24. package/source/user-guide/advanced-content.txt +0 -171
  25. package/source/user-guide/commonmark.txt +0 -156
  26. package/source/user-guide/contents.json +0 -57
  27. package/source/user-guide/files/images/logo.png +0 -0
  28. package/source/user-guide/files/images/overview.png +0 -0
  29. package/source/user-guide/files/images/pdf.png +0 -0
  30. package/source/user-guide/files/images/svg/icon.svg +0 -845
  31. package/source/user-guide/files/images/svg/inkit-logo.svg +0 -9
  32. package/source/user-guide/files/images/svg/overview.svg +0 -1345
  33. package/source/user-guide/files/images/text.png +0 -0
  34. package/source/user-guide/files/images/web.png +0 -0
  35. package/source/user-guide/index.txt +0 -258
  36. package/source/user-guide/installation.txt +0 -49
  37. package/source/user-guide/parameters.json +0 -37
  38. package/source/user-guide/release-notes.txt +0 -70
  39. package/source/user-guide/running.txt +0 -47
  40. package/source/user-guide/troubleshooting.txt +0 -32
  41. package/source/user-guide/upgrading.txt +0 -25
  42. package/source/user-guide/version-control.txt +0 -13
  43. package/source/user-guide/writing-content.txt +0 -269
  44. package/tsconfig.json +0 -8
  45. /package/{source → dist/source}/optional/katex/fonts/KaTeX_AMS-Regular.woff +0 -0
  46. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Main-Bold.woff +0 -0
  47. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Main-Italic.woff +0 -0
  48. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Main-Regular.woff +0 -0
  49. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Math-BoldItalic.woff +0 -0
  50. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Math-Italic.woff +0 -0
  51. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Math-Regular.woff +0 -0
  52. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Size1-Regular.woff +0 -0
  53. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Size2-Regular.woff +0 -0
  54. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Size3-Regular.woff +0 -0
  55. /package/{source → dist/source}/optional/katex/fonts/KaTeX_Size4-Regular.woff +0 -0
  56. /package/{source → dist/source}/optional/katex/katex.min.css +0 -0
  57. /package/{source → dist/source}/optional/katex/katex.min.js +0 -0
  58. /package/{source → dist/source}/pdf-contents.xsl +0 -0
  59. /package/{source → dist/source}/require/docgen.css +0 -0
  60. /package/{source → dist/source}/require/katexInjector.js +0 -0
  61. /package/{source → dist/source}/require/print.css +0 -0
  62. /package/{source → dist/source}/require/webknife/fonts/DroidSansMono.woff +0 -0
  63. /package/{source → dist/source}/require/webknife/fonts/OpenSans.woff +0 -0
  64. /package/{source → dist/source}/require/webknife/fonts/OpenSansBold.woff +0 -0
  65. /package/{source → dist/source}/require/webknife/fonts/OpenSansBoldItalic.woff +0 -0
  66. /package/{source → dist/source}/require/webknife/fonts/OpenSansItalic.woff +0 -0
  67. /package/{source → dist/source}/require/webknife/framework.icons.js +0 -0
  68. /package/{source → dist/source}/require/webknife/framework.min.css +0 -0
  69. /package/{source → dist/source}/require/webknife/framework.min.js +0 -0
  70. /package/{source → dist/source}/require/webknife/highlight.min.css +0 -0
  71. /package/{source → dist/source}/require/webknife/highlight.min.js +0 -0
  72. /package/{source → dist/source}/templates/main.html +0 -0
  73. /package/{source → dist/source}/templates/pdfCover.html +0 -0
  74. /package/{source → dist/source}/templates/pdfFooter.html +0 -0
  75. /package/{source → dist/source}/templates/pdfHeader.html +0 -0
  76. /package/{source → dist/source}/templates/redirect.html +0 -0
  77. /package/{source → dist/source}/templates/webCover.html +0 -0
package/source/example/contents.json DELETED
@@ -1,12 +0,0 @@
1
- [
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 DELETED
@@ -1,4 +0,0 @@
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
- [user guide](http://mtmacdonald.github.io/docgen/).
package/source/example/parameters.json DELETED
@@ -1,37 +0,0 @@
1
- {
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/example/release-notes.txt DELETED
@@ -1 +0,0 @@
1
- There are no releases and no changes recorded for this product yet.
package/source/internal-readme.md DELETED
@@ -1,4 +0,0 @@
1
- To regenerate the docs site:
2
-
3
- ./docgen run -i ./source/user-guide -o ./docs -p -m -n -d 30000
4
-