@xpack/doxygen2docusaurus 1.1.0 → 2.1.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 (329) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +4 -3
  3. package/bin/doxygen2docusaurus.js +1 -1
  4. package/dist/cli/main.d.ts +0 -8
  5. package/dist/cli/main.d.ts.map +1 -1
  6. package/dist/cli/main.js +1 -29
  7. package/dist/cli/main.js.map +1 -1
  8. package/dist/docusaurus/cli-options.d.ts +4 -65
  9. package/dist/docusaurus/cli-options.d.ts.map +1 -1
  10. package/dist/docusaurus/cli-options.js +16 -91
  11. package/dist/docusaurus/cli-options.js.map +1 -1
  12. package/dist/docusaurus/generator.d.ts +7 -4
  13. package/dist/docusaurus/generator.d.ts.map +1 -1
  14. package/dist/docusaurus/generator.js +50 -140
  15. package/dist/docusaurus/generator.js.map +1 -1
  16. package/dist/docusaurus/renderers/descriptiontype.d.ts.map +1 -1
  17. package/dist/docusaurus/renderers/descriptiontype.js +11 -138
  18. package/dist/docusaurus/renderers/descriptiontype.js.map +1 -1
  19. package/dist/docusaurus/renderers/docinternalstype.d.ts.map +1 -1
  20. package/dist/docusaurus/renderers/docinternalstype.js +0 -24
  21. package/dist/docusaurus/renderers/docinternalstype.js.map +1 -1
  22. package/dist/docusaurus/renderers/doclisttype.d.ts.map +1 -1
  23. package/dist/docusaurus/renderers/doclisttype.js +0 -22
  24. package/dist/docusaurus/renderers/doclisttype.js.map +1 -1
  25. package/dist/docusaurus/renderers/doctabletype.d.ts.map +1 -1
  26. package/dist/docusaurus/renderers/doctabletype.js +1 -25
  27. package/dist/docusaurus/renderers/doctabletype.js.map +1 -1
  28. package/dist/docusaurus/renderers/doctitletype.d.ts.map +1 -1
  29. package/dist/docusaurus/renderers/doctitletype.js +0 -20
  30. package/dist/docusaurus/renderers/doctitletype.js.map +1 -1
  31. package/dist/docusaurus/renderers/docvariablelisttype.d.ts.map +1 -1
  32. package/dist/docusaurus/renderers/docvariablelisttype.js +1 -25
  33. package/dist/docusaurus/renderers/docvariablelisttype.js.map +1 -1
  34. package/dist/docusaurus/renderers/docxrefsecttype.d.ts.map +1 -1
  35. package/dist/docusaurus/renderers/docxrefsecttype.js +0 -16
  36. package/dist/docusaurus/renderers/docxrefsecttype.js.map +1 -1
  37. package/dist/docusaurus/renderers/element-renderer-base.d.ts.map +1 -1
  38. package/dist/docusaurus/renderers/element-renderer-base.js +0 -12
  39. package/dist/docusaurus/renderers/element-renderer-base.js.map +1 -1
  40. package/dist/docusaurus/renderers/inctype.d.ts.map +1 -1
  41. package/dist/docusaurus/renderers/inctype.js +0 -18
  42. package/dist/docusaurus/renderers/inctype.js.map +1 -1
  43. package/dist/docusaurus/renderers/linkedtexttype.d.ts.map +1 -1
  44. package/dist/docusaurus/renderers/linkedtexttype.js +0 -23
  45. package/dist/docusaurus/renderers/linkedtexttype.js.map +1 -1
  46. package/dist/docusaurus/renderers/listingtype.d.ts.map +1 -1
  47. package/dist/docusaurus/renderers/listingtype.js +1 -24
  48. package/dist/docusaurus/renderers/listingtype.js.map +1 -1
  49. package/dist/docusaurus/renderers/paramtype.d.ts.map +1 -1
  50. package/dist/docusaurus/renderers/paramtype.js +2 -29
  51. package/dist/docusaurus/renderers/paramtype.js.map +1 -1
  52. package/dist/docusaurus/renderers/referencetype.d.ts.map +1 -1
  53. package/dist/docusaurus/renderers/referencetype.js +0 -17
  54. package/dist/docusaurus/renderers/referencetype.js.map +1 -1
  55. package/dist/docusaurus/renderers/reftexttype.d.ts.map +1 -1
  56. package/dist/docusaurus/renderers/reftexttype.js +0 -16
  57. package/dist/docusaurus/renderers/reftexttype.js.map +1 -1
  58. package/dist/docusaurus/renderers/reftype.d.ts.map +1 -1
  59. package/dist/docusaurus/renderers/reftype.js +0 -16
  60. package/dist/docusaurus/renderers/reftype.js.map +1 -1
  61. package/dist/docusaurus/renderers/renderers.d.ts.map +1 -1
  62. package/dist/docusaurus/renderers/renderers.js +4 -33
  63. package/dist/docusaurus/renderers/renderers.js.map +1 -1
  64. package/dist/docusaurus/renderers/substringtype.d.ts.map +1 -1
  65. package/dist/docusaurus/renderers/substringtype.js +0 -17
  66. package/dist/docusaurus/renderers/substringtype.js.map +1 -1
  67. package/dist/docusaurus/renderers/tableofcontentstype.d.ts.map +1 -1
  68. package/dist/docusaurus/renderers/tableofcontentstype.js +0 -17
  69. package/dist/docusaurus/renderers/tableofcontentstype.js.map +1 -1
  70. package/dist/docusaurus/types.d.ts +4 -8
  71. package/dist/docusaurus/types.d.ts.map +1 -1
  72. package/dist/docusaurus/types.js +0 -11
  73. package/dist/docusaurus/types.js.map +1 -1
  74. package/dist/docusaurus/utils.d.ts.map +1 -1
  75. package/dist/docusaurus/utils.js +0 -82
  76. package/dist/docusaurus/utils.js.map +1 -1
  77. package/dist/docusaurus/view-model/classes-vm.d.ts +2 -2
  78. package/dist/docusaurus/view-model/classes-vm.d.ts.map +1 -1
  79. package/dist/docusaurus/view-model/classes-vm.js +12 -87
  80. package/dist/docusaurus/view-model/classes-vm.js.map +1 -1
  81. package/dist/docusaurus/view-model/collection-base.d.ts +2 -2
  82. package/dist/docusaurus/view-model/collection-base.d.ts.map +1 -1
  83. package/dist/docusaurus/view-model/collection-base.js +11 -23
  84. package/dist/docusaurus/view-model/collection-base.js.map +1 -1
  85. package/dist/docusaurus/view-model/compound-base-vm.d.ts +2 -32
  86. package/dist/docusaurus/view-model/compound-base-vm.d.ts.map +1 -1
  87. package/dist/docusaurus/view-model/compound-base-vm.js +47 -129
  88. package/dist/docusaurus/view-model/compound-base-vm.js.map +1 -1
  89. package/dist/docusaurus/view-model/concepts-vm.d.ts +26 -0
  90. package/dist/docusaurus/view-model/concepts-vm.d.ts.map +1 -0
  91. package/dist/docusaurus/view-model/concepts-vm.js +329 -0
  92. package/dist/docusaurus/view-model/concepts-vm.js.map +1 -0
  93. package/dist/docusaurus/view-model/description-anchors.d.ts.map +1 -1
  94. package/dist/docusaurus/view-model/description-anchors.js +0 -13
  95. package/dist/docusaurus/view-model/description-anchors.js.map +1 -1
  96. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts +2 -2
  97. package/dist/docusaurus/view-model/files-and-folders-vm.d.ts.map +1 -1
  98. package/dist/docusaurus/view-model/files-and-folders-vm.js +64 -110
  99. package/dist/docusaurus/view-model/files-and-folders-vm.js.map +1 -1
  100. package/dist/docusaurus/view-model/groups-vm.d.ts +2 -2
  101. package/dist/docusaurus/view-model/groups-vm.d.ts.map +1 -1
  102. package/dist/docusaurus/view-model/groups-vm.js +7 -80
  103. package/dist/docusaurus/view-model/groups-vm.js.map +1 -1
  104. package/dist/docusaurus/view-model/members-vm.d.ts.map +1 -1
  105. package/dist/docusaurus/view-model/members-vm.js +17 -154
  106. package/dist/docusaurus/view-model/members-vm.js.map +1 -1
  107. package/dist/docusaurus/view-model/namespaces-vm.d.ts +6 -2
  108. package/dist/docusaurus/view-model/namespaces-vm.d.ts.map +1 -1
  109. package/dist/docusaurus/view-model/namespaces-vm.js +82 -89
  110. package/dist/docusaurus/view-model/namespaces-vm.js.map +1 -1
  111. package/dist/docusaurus/view-model/options.d.ts.map +1 -1
  112. package/dist/docusaurus/view-model/options.js +0 -14
  113. package/dist/docusaurus/view-model/options.js.map +1 -1
  114. package/dist/docusaurus/view-model/pages-vm.d.ts +2 -2
  115. package/dist/docusaurus/view-model/pages-vm.d.ts.map +1 -1
  116. package/dist/docusaurus/view-model/pages-vm.js +3 -50
  117. package/dist/docusaurus/view-model/pages-vm.js.map +1 -1
  118. package/dist/docusaurus/view-model/tree-entries-vm.d.ts +8 -22
  119. package/dist/docusaurus/view-model/tree-entries-vm.d.ts.map +1 -1
  120. package/dist/docusaurus/view-model/tree-entries-vm.js +54 -54
  121. package/dist/docusaurus/view-model/tree-entries-vm.js.map +1 -1
  122. package/dist/docusaurus/view-model/view-model.d.ts +0 -6
  123. package/dist/docusaurus/view-model/view-model.d.ts.map +1 -1
  124. package/dist/docusaurus/view-model/view-model.js +20 -63
  125. package/dist/docusaurus/view-model/view-model.js.map +1 -1
  126. package/dist/docusaurus/workspace.d.ts +1 -20
  127. package/dist/docusaurus/workspace.d.ts.map +1 -1
  128. package/dist/docusaurus/workspace.js +9 -116
  129. package/dist/docusaurus/workspace.js.map +1 -1
  130. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts +5 -7
  131. package/dist/doxygen/data-model/compounds/compounddef-dm.d.ts.map +1 -1
  132. package/dist/doxygen/data-model/compounds/compounddef-dm.js +23 -187
  133. package/dist/doxygen/data-model/compounds/compounddef-dm.js.map +1 -1
  134. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts +0 -9
  135. package/dist/doxygen/data-model/compounds/compoundreftype-dm.d.ts.map +1 -1
  136. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js +1 -47
  137. package/dist/doxygen/data-model/compounds/compoundreftype-dm.js.map +1 -1
  138. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts +0 -39
  139. package/dist/doxygen/data-model/compounds/descriptiontype-dm.d.ts.map +1 -1
  140. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js +36 -1308
  141. package/dist/doxygen/data-model/compounds/descriptiontype-dm.js.map +1 -1
  142. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.d.ts.map +1 -1
  143. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js +0 -64
  144. package/dist/doxygen/data-model/compounds/docvarlistentrytype-dm.js.map +1 -1
  145. package/dist/doxygen/data-model/compounds/doxygentype-dm.d.ts.map +1 -1
  146. package/dist/doxygen/data-model/compounds/doxygentype-dm.js +0 -35
  147. package/dist/doxygen/data-model/compounds/doxygentype-dm.js.map +1 -1
  148. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts +0 -6
  149. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.d.ts.map +1 -1
  150. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js +1 -44
  151. package/dist/doxygen/data-model/compounds/enumvaluetype-dm.js.map +1 -1
  152. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts +0 -9
  153. package/dist/doxygen/data-model/compounds/inctype-dm.d.ts.map +1 -1
  154. package/dist/doxygen/data-model/compounds/inctype-dm.js +3 -48
  155. package/dist/doxygen/data-model/compounds/inctype-dm.js.map +1 -1
  156. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts +3 -15
  157. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.d.ts.map +1 -1
  158. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js +5 -57
  159. package/dist/doxygen/data-model/compounds/linkedtexttype-dm.js.map +1 -1
  160. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts +0 -6
  161. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.d.ts.map +1 -1
  162. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js +0 -38
  163. package/dist/doxygen/data-model/compounds/listofallmemberstype-dm.js.map +1 -1
  164. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts +0 -6
  165. package/dist/doxygen/data-model/compounds/locationtype-dm.d.ts.map +1 -1
  166. package/dist/doxygen/data-model/compounds/locationtype-dm.js +4 -52
  167. package/dist/doxygen/data-model/compounds/locationtype-dm.js.map +1 -1
  168. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts +2 -10
  169. package/dist/doxygen/data-model/compounds/memberdeftype-dm.d.ts.map +1 -1
  170. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js +19 -64
  171. package/dist/doxygen/data-model/compounds/memberdeftype-dm.js.map +1 -1
  172. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts +0 -6
  173. package/dist/doxygen/data-model/compounds/memberreftype-dm.d.ts.map +1 -1
  174. package/dist/doxygen/data-model/compounds/memberreftype-dm.js +1 -45
  175. package/dist/doxygen/data-model/compounds/memberreftype-dm.js.map +1 -1
  176. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts +0 -6
  177. package/dist/doxygen/data-model/compounds/membertype-dm.d.ts.map +1 -1
  178. package/dist/doxygen/data-model/compounds/membertype-dm.js +0 -43
  179. package/dist/doxygen/data-model/compounds/membertype-dm.js.map +1 -1
  180. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts +0 -6
  181. package/dist/doxygen/data-model/compounds/paramtype-dm.d.ts.map +1 -1
  182. package/dist/doxygen/data-model/compounds/paramtype-dm.js +0 -51
  183. package/dist/doxygen/data-model/compounds/paramtype-dm.js.map +1 -1
  184. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts +0 -9
  185. package/dist/doxygen/data-model/compounds/referencetype-dm.d.ts.map +1 -1
  186. package/dist/doxygen/data-model/compounds/referencetype-dm.js +2 -47
  187. package/dist/doxygen/data-model/compounds/referencetype-dm.js.map +1 -1
  188. package/dist/doxygen/data-model/compounds/reftexttype-dm.d.ts.map +1 -1
  189. package/dist/doxygen/data-model/compounds/reftexttype-dm.js +2 -38
  190. package/dist/doxygen/data-model/compounds/reftexttype-dm.js.map +1 -1
  191. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts +0 -21
  192. package/dist/doxygen/data-model/compounds/reftype-dm.d.ts.map +1 -1
  193. package/dist/doxygen/data-model/compounds/reftype-dm.js +4 -82
  194. package/dist/doxygen/data-model/compounds/reftype-dm.js.map +1 -1
  195. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts +0 -6
  196. package/dist/doxygen/data-model/compounds/reimplementtype-dm.d.ts.map +1 -1
  197. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js +1 -42
  198. package/dist/doxygen/data-model/compounds/reimplementtype-dm.js.map +1 -1
  199. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts +0 -9
  200. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.d.ts.map +1 -1
  201. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js +0 -53
  202. package/dist/doxygen/data-model/compounds/sectiondeftype-dm.js.map +1 -1
  203. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts +0 -12
  204. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.d.ts.map +1 -1
  205. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js +0 -105
  206. package/dist/doxygen/data-model/compounds/tableofcontentstype-dm.js.map +1 -1
  207. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts +0 -6
  208. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.d.ts.map +1 -1
  209. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js +0 -38
  210. package/dist/doxygen/data-model/compounds/templateparamlisttype-dm.js.map +1 -1
  211. package/dist/doxygen/data-model/data-model.d.ts +0 -65
  212. package/dist/doxygen/data-model/data-model.d.ts.map +1 -1
  213. package/dist/doxygen/data-model/data-model.js +4 -115
  214. package/dist/doxygen/data-model/data-model.js.map +1 -1
  215. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts +0 -6
  216. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.d.ts.map +1 -1
  217. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js +4 -47
  218. package/dist/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.js.map +1 -1
  219. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts +0 -6
  220. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.d.ts.map +1 -1
  221. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js +0 -40
  222. package/dist/doxygen/data-model/doxyfile/doxyfiletype-dm.js.map +1 -1
  223. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts +0 -236
  224. package/dist/doxygen/data-model/doxygen-xml-parser.d.ts.map +1 -1
  225. package/dist/doxygen/data-model/doxygen-xml-parser.js +0 -289
  226. package/dist/doxygen/data-model/doxygen-xml-parser.js.map +1 -1
  227. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts +0 -6
  228. package/dist/doxygen/data-model/index/indexcompoundtype-dm.d.ts.map +1 -1
  229. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js +2 -45
  230. package/dist/doxygen/data-model/index/indexcompoundtype-dm.js.map +1 -1
  231. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts +0 -6
  232. package/dist/doxygen/data-model/index/indexdoxygentype-dm.d.ts.map +1 -1
  233. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js +0 -41
  234. package/dist/doxygen/data-model/index/indexdoxygentype-dm.js.map +1 -1
  235. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts +0 -6
  236. package/dist/doxygen/data-model/index/indexmembertype-dm.d.ts.map +1 -1
  237. package/dist/doxygen/data-model/index/indexmembertype-dm.js +1 -43
  238. package/dist/doxygen/data-model/index/indexmembertype-dm.js.map +1 -1
  239. package/dist/doxygen/data-model/types.d.ts +1 -10
  240. package/dist/doxygen/data-model/types.d.ts.map +1 -1
  241. package/dist/doxygen/data-model/types.js +0 -15
  242. package/dist/doxygen/data-model/types.js.map +1 -1
  243. package/dist/index.d.ts +4 -16
  244. package/dist/index.d.ts.map +1 -1
  245. package/dist/index.js +4 -42
  246. package/dist/index.js.map +1 -1
  247. package/package.json +53 -56
  248. package/src/cli/main.ts +122 -0
  249. package/src/docusaurus/cli-options.ts +560 -0
  250. package/src/docusaurus/generator.ts +788 -0
  251. package/src/docusaurus/renderers/descriptiontype.ts +1299 -0
  252. package/src/docusaurus/renderers/docinternalstype.ts +354 -0
  253. package/src/docusaurus/renderers/doclisttype.ts +134 -0
  254. package/src/docusaurus/renderers/doctabletype.ts +220 -0
  255. package/src/docusaurus/renderers/doctitletype.ts +77 -0
  256. package/src/docusaurus/renderers/docvariablelisttype.ts +123 -0
  257. package/src/docusaurus/renderers/docxrefsecttype.ts +84 -0
  258. package/src/docusaurus/renderers/element-renderer-base.ts +112 -0
  259. package/src/docusaurus/renderers/inctype.ts +75 -0
  260. package/src/docusaurus/renderers/linkedtexttype.ts +64 -0
  261. package/src/docusaurus/renderers/listingtype.ts +235 -0
  262. package/src/docusaurus/renderers/paramtype.ts +116 -0
  263. package/src/docusaurus/renderers/referencetype.ts +83 -0
  264. package/src/docusaurus/renderers/reftexttype.ts +81 -0
  265. package/src/docusaurus/renderers/reftype.ts +77 -0
  266. package/src/docusaurus/renderers/renderers.ts +756 -0
  267. package/src/docusaurus/renderers/substringtype.ts +53 -0
  268. package/src/docusaurus/renderers/tableofcontentstype.ts +74 -0
  269. package/src/docusaurus/types.ts +187 -0
  270. package/src/docusaurus/utils.ts +409 -0
  271. package/src/docusaurus/view-model/README.md +12 -0
  272. package/src/docusaurus/view-model/classes-vm.ts +1088 -0
  273. package/src/docusaurus/view-model/collection-base.ts +352 -0
  274. package/src/docusaurus/view-model/compound-base-vm.ts +1340 -0
  275. package/src/docusaurus/view-model/concepts-vm.ts +719 -0
  276. package/src/docusaurus/view-model/description-anchors.ts +107 -0
  277. package/src/docusaurus/view-model/files-and-folders-vm.ts +1293 -0
  278. package/src/docusaurus/view-model/groups-vm.ts +548 -0
  279. package/src/docusaurus/view-model/members-vm.ts +1943 -0
  280. package/src/docusaurus/view-model/namespaces-vm.ts +1018 -0
  281. package/src/docusaurus/view-model/options.ts +95 -0
  282. package/src/docusaurus/view-model/pages-vm.ts +342 -0
  283. package/src/docusaurus/view-model/tree-entries-vm.ts +376 -0
  284. package/src/docusaurus/view-model/view-model.ts +513 -0
  285. package/src/docusaurus/workspace.ts +588 -0
  286. package/src/doxygen/data-model/README.md +13 -0
  287. package/src/doxygen/data-model/compounds/compounddef-dm.ts +1156 -0
  288. package/src/doxygen/data-model/compounds/compoundreftype-dm.ts +266 -0
  289. package/src/doxygen/data-model/compounds/descriptiontype-dm.ts +10107 -0
  290. package/src/doxygen/data-model/compounds/docvarlistentrytype-dm.ts +354 -0
  291. package/src/doxygen/data-model/compounds/doxygentype-dm.ts +187 -0
  292. package/src/doxygen/data-model/compounds/enumvaluetype-dm.ts +218 -0
  293. package/src/doxygen/data-model/compounds/inctype-dm.ts +217 -0
  294. package/src/doxygen/data-model/compounds/linkedtexttype-dm.ts +288 -0
  295. package/src/doxygen/data-model/compounds/listofallmemberstype-dm.ts +160 -0
  296. package/src/doxygen/data-model/compounds/locationtype-dm.ts +284 -0
  297. package/src/doxygen/data-model/compounds/memberdeftype-dm.ts +874 -0
  298. package/src/doxygen/data-model/compounds/memberreftype-dm.ts +270 -0
  299. package/src/doxygen/data-model/compounds/membertype-dm.ts +239 -0
  300. package/src/doxygen/data-model/compounds/paramtype-dm.ts +302 -0
  301. package/src/doxygen/data-model/compounds/referencetype-dm.ts +248 -0
  302. package/src/doxygen/data-model/compounds/reftexttype-dm.ts +234 -0
  303. package/src/doxygen/data-model/compounds/reftype-dm.ts +430 -0
  304. package/src/doxygen/data-model/compounds/reimplementtype-dm.ts +201 -0
  305. package/src/doxygen/data-model/compounds/sectiondeftype-dm.ts +330 -0
  306. package/src/doxygen/data-model/compounds/tableofcontentstype-dm.ts +563 -0
  307. package/src/doxygen/data-model/compounds/templateparamlisttype-dm.ts +150 -0
  308. package/src/doxygen/data-model/data-model.ts +377 -0
  309. package/src/doxygen/data-model/doxyfile/doxyfileoptiontype-dm.ts +271 -0
  310. package/src/doxygen/data-model/doxyfile/doxyfiletype-dm.ts +200 -0
  311. package/src/doxygen/data-model/doxygen-xml-parser.ts +522 -0
  312. package/src/doxygen/data-model/index/indexcompoundtype-dm.ts +256 -0
  313. package/src/doxygen/data-model/index/indexdoxygentype-dm.ts +196 -0
  314. package/src/doxygen/data-model/index/indexmembertype-dm.ts +230 -0
  315. package/src/doxygen/data-model/types.ts +175 -0
  316. package/src/doxygen/data-model/xsds/README.md +6 -0
  317. package/src/doxygen/data-model/xsds/compound.xsd +1699 -0
  318. package/src/doxygen/data-model/xsds/doxyfile.xsd +355 -0
  319. package/src/doxygen/data-model/xsds/index.xsd +72 -0
  320. package/src/doxygen/data-model/xsds/xml.xsd +23 -0
  321. package/src/index.ts +261 -0
  322. package/src/tsconfig.json +10 -0
  323. package/dist/doxygen2docusaurus.d.ts +0 -1147
  324. package/dist/tsconfig.tsbuildinfo +0 -1
  325. package/dist/tsdoc-metadata.json +0 -11
  326. /package/{template → templates}/css/custom.css +0 -0
  327. /package/{template → templates}/img/README.md +0 -0
  328. /package/{template → templates}/img/document-svgrepo-com.svg +0 -0
  329. /package/{template → templates}/img/folder-svgrepo-com.svg +0 -0
package/LICENSE CHANGED
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2024 Liviu Ionescu
3
+ Copyright (c) 2024-2026 Liviu Ionescu
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy
6
6
  of this software and associated documentation files (the "Software"), to deal
package/README.md CHANGED
@@ -1,20 +1,21 @@
1
1
  [![GitHub package.json version](https://img.shields.io/github/package-json/v/xpack/doxygen2docusaurus-cli-ts)](https://github.com/xpack/doxygen2docusaurus-cli-ts/blob/master/package.json)
2
2
  [![NPM Version](https://img.shields.io/npm/v/@xpack/doxygen2docusaurus?color=blue)](https://www.npmjs.com/package/@xpack/doxygen2docusaurus/)
3
3
  [![license](https://img.shields.io/github/license/xpack/doxygen2docusaurus-cli-ts)](https://github.com/xpack/doxygen2docusaurus-cli-ts/blob/master/LICENSE)
4
+ [![Website](https://img.shields.io/website?url=https%3A%2F%2Fxpack.github.io%2Fdoxygen2docusaurus-cli-ts%2F)](https://xpack.github.io/doxygen2docusaurus/)
4
5
 
5
- # The doxygen2docusaurus
6
+ # The Doxygen Documentation Converter
6
7
 
7
8
  A Node.js CLI application to convert Doxygen XML files into Docusaurus documentation.
8
9
 
9
10
  ## Project documentation
10
11
 
11
12
  For information on how to install and use this project, please refer to the
12
- [project website](https://xpack.github.io/doxygen2docusaurus-cli-ts/).
13
+ [project website](https://xpack.github.io/doxygen2docusaurus/).
13
14
 
14
15
  ## Project source
15
16
 
16
17
  The source code of the current release is available on
17
- [GitHub tag v1.0.2 tree](https://github.com/xpack/doxygen2docusaurus-cli-ts/tree/v1.0.2).
18
+ [GitHub tag v2.1.0 tree](https://github.com/xpack/doxygen2docusaurus-cli-ts/tree/v2.1.0).
18
19
 
19
20
  ## License
20
21
 
@@ -3,7 +3,7 @@
3
3
 
4
4
  /*
5
5
  * This file is part of the xPack project (http://xpack.github.io).
6
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
6
+ * Copyright (c) 2025-2026 Liviu Ionescu. All rights reserved.
7
7
  *
8
8
  * Permission to use, copy, modify, and/or distribute this software
9
9
  * for any purpose is hereby granted, under the terms of the MIT license.
@@ -1,10 +1,2 @@
1
- /**
2
- * Main entry point for the doxygen2docusaurus CLI tool.
3
- *
4
- * @param argv - Command line arguments array
5
- * @returns Promise that resolves to the exit code (0 for success, 1 for error)
6
- *
7
- * @public
8
- */
9
1
  export declare function main(argv: string[]): Promise<number>;
10
2
  //# sourceMappingURL=main.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AA8BA;;;;;;;GAOG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CA2E1D"}
1
+ {"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AA4CA,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CA2E1D"}
package/dist/cli/main.js CHANGED
@@ -1,45 +1,18 @@
1
- /*
2
- * This file is part of the xPack project (http://xpack.github.io).
3
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
4
- *
5
- * Permission to use, copy, modify, and/or distribute this software
6
- * for any purpose is hereby granted, under the terms of the MIT license.
7
- *
8
- * If a copy of the license was not distributed with this file, it can
9
- * be obtained from https://opensource.org/licenses/MIT.
10
- */
11
- // ----------------------------------------------------------------------------
12
- // import assert from 'node:assert'
13
1
  import * as path from 'node:path';
14
2
  import * as fs from 'node:fs/promises';
15
- // import * as util from 'node:util'
16
- // https://www.npmjs.com/package/commander
3
+ import { fileURLToPath } from 'node:url';
17
4
  import { CliOptions } from '../docusaurus/cli-options.js';
18
5
  import { formatDuration } from '../docusaurus/utils.js';
19
6
  import { DataModel } from '../doxygen/data-model/data-model.js';
20
7
  import { DocusaurusGenerator } from '../docusaurus/generator.js';
21
8
  import { Workspace } from '../docusaurus/workspace.js';
22
- import { fileURLToPath } from 'node:url';
23
- // https://www.npmjs.com/package/commander
24
9
  import { Command } from 'commander';
25
- // ----------------------------------------------------------------------------
26
- /**
27
- * Main entry point for the doxygen2docusaurus CLI tool.
28
- *
29
- * @param argv - Command line arguments array
30
- * @returns Promise that resolves to the exit code (0 for success, 1 for error)
31
- *
32
- * @public
33
- */
34
10
  export async function main(argv) {
35
11
  const startTime = Date.now();
36
- // Like .../doxygen2docusaurus/dist/cli
37
12
  const __dirname = path.dirname(fileURLToPath(import.meta.url));
38
13
  const packageJsonPath = path.join(path.dirname(path.dirname(__dirname)), 'package.json');
39
14
  const packageJsonContent = await fs.readFile(packageJsonPath);
40
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
41
15
  const packageJson = JSON.parse(packageJsonContent.toString());
42
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access
43
16
  const packageVersion = packageJson.version;
44
17
  const program = new Command();
45
18
  program.option('--id <name>', 'configuration id, for multi-configurations');
@@ -83,5 +56,4 @@ export async function main(argv) {
83
56
  }
84
57
  return exitCode;
85
58
  }
86
- // ----------------------------------------------------------------------------
87
59
  //# sourceMappingURL=main.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,mCAAmC;AACnC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,oCAAoC;AAEpC,0CAA0C;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AACxC,0CAA0C;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEnC,+EAA+E;AAE/E;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAc;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAE5B,uCAAuC;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC9D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EACrC,cAAc,CACf,CAAA;IACD,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;IAE7D,mEAAmE;IACnE,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC7D,+GAA+G;IAC/G,MAAM,cAAc,GAAW,WAAW,CAAC,OAAO,CAAA;IAElD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;IAE7B,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,4CAA4C,CAAC,CAAA;IAC3E,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAA;IACzE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,2CAA2C,CAAC,CAAA;IACtE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAA;IACxD,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAA;IAClD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEnB,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;IAErC,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAC3B,OAAO,CAAC,CAAA;IACV,CAAC;IAED,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAW,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,WAAW,GAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAA;IACxE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,WAAW,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IAC9C,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,YAAY,WAAW,OAAO,cAAc,MAAM,CAAC,CAAA;IAE/D,MAAM,EAAE,GAAI,cAAc,CAAC,EAAyB,IAAI,SAAS,CAAA;IACjE,MAAM,OAAO,GAAG,cAAc,CAAC,OAA8B,CAAA;IAC7D,MAAM,KAAK,GAAG,cAAc,CAAC,KAA4B,CAAA;IAEzD,MAAM,cAAc,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC7C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,CAAA;IAC9C,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IAErB,IAAI,QAAQ,GAAG,CAAC,CAAA;IAEhB,OAAO,CAAC,GAAG,EAAE,CAAA;IAEb,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAA;IACvB,SAAS,CAAC,cAAc,GAAG,cAAc,CAAA;IAEzC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAA;IAE1C,MAAM,SAAS,GAAG,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACpD,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,CAAA;IAEhC,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAA;IAE7D,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,EAAE,CAAA;QACb,OAAO,CAAC,GAAG,CACT,YAAY,WAAW,+BAA+B;YACpD,MAAM,cAAc,GAAG,CAC1B,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC;AAED,+EAA+E"}
1
+ {"version":3,"file":"main.js","sourceRoot":"","sources":["../../src/cli/main.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AACjC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAIxC,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAA;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACvD,OAAO,EAAE,SAAS,EAAE,MAAM,qCAAqC,CAAA;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAA;AAChE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAA;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAkBnC,MAAM,CAAC,KAAK,UAAU,IAAI,CAAC,IAAc;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IAG5B,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IAC9D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAC/B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EACrC,cAAc,CACf,CAAA;IACD,MAAM,kBAAkB,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAA;IAG7D,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,QAAQ,EAAE,CAAC,CAAA;IAE7D,MAAM,cAAc,GAAW,WAAW,CAAC,OAAO,CAAA;IAElD,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAA;IAE7B,OAAO,CAAC,MAAM,CAAC,aAAa,EAAE,4CAA4C,CAAC,CAAA;IAC3E,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,4CAA4C,CAAC,CAAA;IACzE,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE,2CAA2C,CAAC,CAAA;IACtE,OAAO,CAAC,MAAM,CAAC,WAAW,EAAE,2BAA2B,CAAC,CAAA;IACxD,OAAO,CAAC,MAAM,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAA;IAClD,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IAEnB,MAAM,cAAc,GAAG,OAAO,CAAC,IAAI,EAAE,CAAA;IAErC,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;QAC3B,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAA;QAC3B,OAAO,CAAC,CAAA;IACV,CAAC;IAED,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC;QACrB,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAW,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,WAAW,GAAW,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,oBAAoB,CAAC,CAAA;IACxE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,WAAW,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAA;IAC9C,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,YAAY,WAAW,OAAO,cAAc,MAAM,CAAC,CAAA;IAE/D,MAAM,EAAE,GAAI,cAAc,CAAC,EAAyB,IAAI,SAAS,CAAA;IACjE,MAAM,OAAO,GAAG,cAAc,CAAC,OAA8B,CAAA;IAC7D,MAAM,KAAK,GAAG,cAAc,CAAC,KAA4B,CAAA;IAEzD,MAAM,cAAc,GAAG,EAAE,EAAE,EAAE,OAAO,EAAE,KAAK,EAAE,CAAA;IAC7C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,cAAc,CAAC,CAAA;IAC9C,MAAM,OAAO,CAAC,KAAK,EAAE,CAAA;IAErB,IAAI,QAAQ,GAAG,CAAC,CAAA;IAEhB,OAAO,CAAC,GAAG,EAAE,CAAA;IAEb,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,OAAO,CAAC,CAAA;IACxC,MAAM,SAAS,CAAC,KAAK,EAAE,CAAA;IACvB,SAAS,CAAC,cAAc,GAAG,cAAc,CAAA;IAEzC,MAAM,SAAS,GAAG,IAAI,SAAS,CAAC,SAAS,CAAC,CAAA;IAE1C,MAAM,SAAS,GAAG,IAAI,mBAAmB,CAAC,SAAS,CAAC,CAAA;IACpD,QAAQ,GAAG,MAAM,SAAS,CAAC,GAAG,EAAE,CAAA;IAEhC,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC,CAAA;IAE7D,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QACnB,OAAO,CAAC,GAAG,EAAE,CAAA;QACb,OAAO,CAAC,GAAG,CACT,YAAY,WAAW,+BAA+B;YACpD,MAAM,cAAc,GAAG,CAC1B,CAAA;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC"}
@@ -2,93 +2,32 @@ export interface Redirects {
2
2
  from: string | string[];
3
3
  to: string;
4
4
  }
5
- /**
6
- * Options, as written by the user. All are optional.
7
- *
8
- * @public
9
- */
10
5
  export type CliConfigurationOptions = Record<string, string | boolean>;
11
6
  export type CommandOptions = Record<string, string | boolean | undefined>;
12
- /**
13
- * Options, when multi-configurations are used.
14
- *
15
- * @public
16
- */
17
7
  export type MultiConfigurations = Record<string, CliConfigurationOptions>;
18
- /**
19
- * Options, as seen by the application. Most are mandatory.
20
- *
21
- * @public
22
- */
23
8
  export declare class CliOptions {
24
- /**
25
- * Relative to the current website folder, like `doxygen/xml`, no initial/
26
- * final slashes.
27
- */
28
9
  doxygenXmlInputFolderPath: string;
29
- /**
30
- * Relative to the current website folder, like `docs`, no initial/final
31
- * slashes.
32
- */
33
10
  docsFolderPath: string;
34
- /** Relative to the docs folder, like `api`, no initial/final slashes. */
35
11
  apiFolderPath: string;
36
- /** Site base URL, like / or /xxx/. */
37
12
  baseUrl: string;
38
- /** Relative to the web home, like `docs`, without initial/final slashes. */
39
13
  docsBaseUrl: string;
40
- /** Relative to the docs home, like `api`, without initial/final slashes. */
41
14
  apiBaseUrl: string;
42
- /** Relative to `static` */
43
15
  imagesFolderPath: string;
44
- /** Relative to the current `website/static` folder, like `reference`. */
45
16
  compatibilityRedirectsOutputFolderPath?: string | undefined;
46
- /** The title to be displayed on the main page. */
47
17
  mainPageTitle: string;
48
- /**
49
- * Relative to the current website folder, default
50
- * `sidebar-category-doxygen.json`.
51
- */
52
18
  sidebarCategoryFilePath: string;
53
- /** Short text to be displayed in the sidebar. */
54
19
  sidebarCategoryLabel: string;
55
- /**
56
- * Relative to the current website folder, default
57
- * `docusaurus-config-doxygen-menu-dropdown.json`.
58
- */
59
- menuDropdownFilePath: string;
60
- /** Short text to be displayed in the menu. */
61
- menuDropdownLabel: string;
62
- /**
63
- * Relative to the current website folder, default
64
- * `src/css/custom-doxygen.css`
65
- */
20
+ navbarDropdownFilePath: string;
21
+ navbarDropdownLabel: string;
22
+ navbarDropdownPosition: 'left' | 'right';
66
23
  customCssFilePath: string;
67
- /** Boolean to control verbosity. */
68
24
  verbose: boolean;
69
- /** Boolean to control debug verbosity. */
70
25
  debug: boolean;
71
- /** Boolean to control if the TODO suggestions are shown. */
72
26
  suggestToDoDescriptions: boolean;
73
- /** Boolean to render the pages to the top. */
74
- renderPagesAtTop: boolean;
75
- /** Boolean to render the program listing in the File pages. */
27
+ listPagesAtTop: boolean;
76
28
  renderProgramListing: boolean;
77
- /**
78
- * Boolean to render the program listing in the member definitions sections.
79
- */
80
29
  renderProgramListingInline: boolean;
81
- /**
82
- * Location of original Doxygen pages
83
- *
84
- * 'For comparison, the original Doxygen html pages, styled with the
85
- * <a href="https://jothepro.github.io/doxygen-awesome-css/">doxygen-awesome-css</a>
86
- * plugin, continue to be available via the
87
- * <a href="pathname:///doxygen/topics.html"><code>.../doxygen/*.html</b></code>
88
- * URLs.'
89
- */
90
30
  originalPagesNote: string;
91
- /** String identifier in case of multiple instances. */
92
31
  id: string;
93
32
  constructor(commandOptions: CommandOptions);
94
33
  parse(): Promise<void>;
@@ -1 +1 @@
1
- {"version":3,"file":"cli-options.d.ts","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAoBA,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IACvB,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;AAEtE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAA;AAEzE;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;AAQzE;;;;GAIG;AACH,qBAAa,UAAU;IACrB;;;OAGG;IACH,yBAAyB,SAAgB;IAEzC;;;OAGG;IACH,cAAc,SAAS;IAEvB,yEAAyE;IACzE,aAAa,SAAQ;IAErB,sCAAsC;IACtC,OAAO,SAAM;IAEb,4EAA4E;IAC5E,WAAW,SAAS;IAEpB,4EAA4E;IAC5E,UAAU,SAAQ;IAElB,2BAA2B;IAC3B,gBAAgB,SAAgB;IAEhC,0EAA0E;IAC1E,sCAAsC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAE3D,kDAAkD;IAClD,aAAa,SAAK;IAElB;;;OAGG;IACH,uBAAuB,SAAkC;IAEzD,iDAAiD;IACjD,oBAAoB,SAA4B;IAEhD;;;OAGG;IACH,oBAAoB,SAAwC;IAE5D,8CAA8C;IAC9C,iBAAiB,SAAc;IAE/B;;;OAGG;IACH,iBAAiB,SAA0C;IAE3D,oCAAoC;IACpC,OAAO,UAAQ;IAEf,0CAA0C;IAC1C,KAAK,UAAQ;IAEb,4DAA4D;IAC5D,uBAAuB,UAAQ;IAE/B,8CAA8C;IAC9C,gBAAgB,UAAO;IAEvB,+DAA+D;IAC/D,oBAAoB,UAAO;IAE3B;;OAEG;IACH,0BAA0B,UAAO;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,SAAK;IAEtB,uDAAuD;IACvD,EAAE,SAAY;gBAEF,cAAc,EAAE,cAAc;IA4BpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAuH5B,wBAAwB,CACtB,mBAAmB,EAAE,uBAAuB,GAAG,mBAAmB,GACjE,uBAAuB,GAAG,SAAS;CAkBvC;AAGD,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAEpC,eAAO,MAAM,mBAAmB,KAAK,CAAA"}
1
+ {"version":3,"file":"cli-options.d.ts","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAyBA,MAAM,WAAW,SAAS;IAExB,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEvB,EAAE,EAAE,MAAM,CAAA;CACX;AAWD,MAAM,MAAM,uBAAuB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,CAAA;AAWtE,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAC,CAAA;AAWzE,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC,MAAM,EAAE,uBAAuB,CAAC,CAAA;AAyBzE,qBAAa,UAAU;IAWrB,yBAAyB,SAAgB;IAYzC,cAAc,SAAS;IAYvB,aAAa,SAAQ;IAWrB,OAAO,SAAM;IAWb,WAAW,SAAS;IAWpB,UAAU,SAAQ;IAWlB,gBAAgB,SAA0B;IAU1C,sCAAsC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAY3D,aAAa,SAAK;IAWlB,uBAAuB,SAAkC;IAWzD,oBAAoB,SAA4B;IAWhD,sBAAsB,SAA0C;IAWhE,mBAAmB,SAAkB;IAWrC,sBAAsB,EAAE,MAAM,GAAG,OAAO,CAAS;IAYjD,iBAAiB,SAA0C;IAW3D,OAAO,UAAQ;IAWf,KAAK,UAAQ;IAWb,uBAAuB,UAAQ;IAW/B,cAAc,UAAO;IAWrB,oBAAoB,UAAO;IAW3B,0BAA0B,UAAO;IAWjC,iBAAiB,SAAK;IAYtB,EAAE,SAAY;gBAaF,cAAc,EAAE,cAAc;IAuCpC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAkI5B,wBAAwB,CACtB,mBAAmB,EAAE,uBAAuB,GAAG,mBAAmB,GACjE,uBAAuB,GAAG,SAAS;CAsBvC;AAGD,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAGpC,eAAO,MAAM,mBAAmB,KAAK,CAAA"}
@@ -1,91 +1,29 @@
1
- /*
2
- * This file is part of the xPack project (http://xpack.github.io).
3
- * Copyright (c) 2025 Liviu Ionescu. All rights reserved.
4
- *
5
- * Permission to use, copy, modify, and/or distribute this software
6
- * for any purpose is hereby granted, under the terms of the MIT license.
7
- *
8
- * If a copy of the license was not distributed with this file, it can
9
- * be obtained from https://opensource.org/licenses/MIT.
10
- */
11
- // ----------------------------------------------------------------------------
12
1
  import assert from 'node:assert';
13
2
  import * as fs from 'node:fs/promises';
14
3
  import * as path from 'node:path';
15
- /**
16
- * Options, as seen by the application. Most are mandatory.
17
- *
18
- * @public
19
- */
20
4
  export class CliOptions {
21
- /**
22
- * Relative to the current website folder, like `doxygen/xml`, no initial/
23
- * final slashes.
24
- */
25
5
  doxygenXmlInputFolderPath = 'doxygen/xml';
26
- /**
27
- * Relative to the current website folder, like `docs`, no initial/final
28
- * slashes.
29
- */
30
6
  docsFolderPath = 'docs';
31
- /** Relative to the docs folder, like `api`, no initial/final slashes. */
32
7
  apiFolderPath = 'api';
33
- /** Site base URL, like / or /xxx/. */
34
8
  baseUrl = '/';
35
- /** Relative to the web home, like `docs`, without initial/final slashes. */
36
9
  docsBaseUrl = 'docs';
37
- /** Relative to the docs home, like `api`, without initial/final slashes. */
38
10
  apiBaseUrl = 'api';
39
- /** Relative to `static` */
40
- imagesFolderPath = 'img/doxygen';
41
- /** Relative to the current `website/static` folder, like `reference`. */
11
+ imagesFolderPath = 'assets/images/doxygen';
42
12
  compatibilityRedirectsOutputFolderPath;
43
- /** The title to be displayed on the main page. */
44
13
  mainPageTitle = '';
45
- /**
46
- * Relative to the current website folder, default
47
- * `sidebar-category-doxygen.json`.
48
- */
49
14
  sidebarCategoryFilePath = 'sidebar-category-doxygen.json';
50
- /** Short text to be displayed in the sidebar. */
51
15
  sidebarCategoryLabel = 'API Reference (Doxygen)';
52
- /**
53
- * Relative to the current website folder, default
54
- * `docusaurus-config-doxygen-menu-dropdown.json`.
55
- */
56
- menuDropdownFilePath = 'docusaurus-config-menu-doxygen.json';
57
- /** Short text to be displayed in the menu. */
58
- menuDropdownLabel = 'Reference';
59
- /**
60
- * Relative to the current website folder, default
61
- * `src/css/custom-doxygen.css`
62
- */
16
+ navbarDropdownFilePath = 'docusaurus-config-navbar-doxygen.json';
17
+ navbarDropdownLabel = 'API Reference';
18
+ navbarDropdownPosition = 'left';
63
19
  customCssFilePath = 'src/css/custom-doxygen2docusaurus.css';
64
- /** Boolean to control verbosity. */
65
20
  verbose = false;
66
- /** Boolean to control debug verbosity. */
67
21
  debug = false;
68
- /** Boolean to control if the TODO suggestions are shown. */
69
22
  suggestToDoDescriptions = false;
70
- /** Boolean to render the pages to the top. */
71
- renderPagesAtTop = true;
72
- /** Boolean to render the program listing in the File pages. */
23
+ listPagesAtTop = true;
73
24
  renderProgramListing = true;
74
- /**
75
- * Boolean to render the program listing in the member definitions sections.
76
- */
77
25
  renderProgramListingInline = true;
78
- /**
79
- * Location of original Doxygen pages
80
- *
81
- * 'For comparison, the original Doxygen html pages, styled with the
82
- * <a href="https://jothepro.github.io/doxygen-awesome-css/">doxygen-awesome-css</a>
83
- * plugin, continue to be available via the
84
- * <a href="pathname:///doxygen/topics.html"><code>.../doxygen/*.html</b></code>
85
- * URLs.'
86
- */
87
26
  originalPagesNote = '';
88
- /** String identifier in case of multiple instances. */
89
27
  id = 'default';
90
28
  constructor(commandOptions) {
91
29
  this.id = commandOptions.id;
@@ -101,7 +39,7 @@ export class CliOptions {
101
39
  this.imagesFolderPath = `img/doxygen-${this.id}`;
102
40
  this.sidebarCategoryFilePath =
103
41
  'sidebar-category-doxygen' + `-${this.id}.json`;
104
- this.menuDropdownFilePath =
42
+ this.navbarDropdownFilePath =
105
43
  'docusaurus-config-navbar-doxygen' + `-${this.id}.json`;
106
44
  }
107
45
  else {
@@ -109,7 +47,7 @@ export class CliOptions {
109
47
  this.apiBaseUrl = 'api';
110
48
  this.imagesFolderPath = `img/doxygen`;
111
49
  this.sidebarCategoryFilePath = `sidebar-category-doxygen.json`;
112
- this.menuDropdownFilePath = `docusaurus-config-navbar-doxygen.json`;
50
+ this.navbarDropdownFilePath = `docusaurus-config-navbar-doxygen.json`;
113
51
  }
114
52
  }
115
53
  async parse() {
@@ -117,64 +55,50 @@ export class CliOptions {
117
55
  try {
118
56
  const userPackageJsonPath = path.resolve(process.cwd(), 'config', 'doxygen2docusaurus.json');
119
57
  const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
120
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
121
58
  const multiConfigurations = JSON.parse(pkgJsonRaw);
122
59
  configurationOptions = this.selectMultiConfiguration(multiConfigurations);
123
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
124
60
  }
125
61
  catch (err) {
126
- /* Cannot read/parse JSON */
127
62
  }
128
63
  if (configurationOptions === undefined) {
129
64
  try {
130
65
  const userPackageJsonPath = path.resolve(process.cwd(), 'doxygen2docusaurus.json');
131
66
  const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
132
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
133
67
  const multiConfigurations = JSON.parse(pkgJsonRaw);
134
68
  configurationOptions =
135
69
  this.selectMultiConfiguration(multiConfigurations);
136
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
137
70
  }
138
71
  catch (err) {
139
- /* Cannot read/parse JSON */
140
72
  }
141
73
  }
142
74
  if (configurationOptions === undefined) {
143
75
  try {
144
- // Try to get the configuration from
145
- // package.json/[config/]doxygen2docusaurus.
146
76
  const userPackageJsonPath = path.resolve(process.cwd(), 'package.json');
147
77
  const pkgJsonRaw = await fs.readFile(userPackageJsonPath, 'utf8');
148
- // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
149
78
  const pkgJson = JSON.parse(pkgJsonRaw);
150
79
  const multiConfigurations = pkgJson.config?.doxygen2docusaurus ?? pkgJson.doxygen2docusaurus;
151
80
  if (multiConfigurations !== undefined) {
152
81
  configurationOptions =
153
82
  this.selectMultiConfiguration(multiConfigurations);
154
83
  }
155
- // eslint-disable-next-line @typescript-eslint/no-unused-vars
156
84
  }
157
85
  catch (err) {
158
- /* Cannot read/parse JSON */
159
86
  }
160
87
  }
161
- if (this.debug) {
162
- console.log(configurationOptions);
163
- }
164
88
  if (configurationOptions !== undefined) {
165
- // Override only properties that exist in CliOptions
89
+ if (this.debug) {
90
+ console.log(configurationOptions);
91
+ }
166
92
  const thisProperties = Object.getOwnPropertyNames(this);
167
93
  for (const key of Object.keys(configurationOptions)) {
168
94
  const value = configurationOptions[key];
169
- // console.log(key, value)
170
95
  if (value !== undefined && thisProperties.includes(key)) {
171
96
  const thisProperty = this[key];
172
97
  const thisType = typeof thisProperty;
173
98
  const valueType = typeof value;
174
- if (['id', 'verbose', 'debug'].includes(key)) {
99
+ if (['id'].includes(key)) {
175
100
  continue;
176
101
  }
177
- // Override only if types match.
178
102
  if (thisType === valueType) {
179
103
  ;
180
104
  this[key] = value;
@@ -193,7 +117,6 @@ export class CliOptions {
193
117
  assert(this.docsFolderPath.length > 0, 'docsFolderPath is required');
194
118
  assert(this.apiFolderPath.length > 0, 'apiFolderPath is required');
195
119
  assert(this.docsBaseUrl.length > 0, 'docsBaseUrl is required');
196
- // assert(this.apiBaseUrl.length > 0, 'apiBaseUrl is required')
197
120
  assert(this.sidebarCategoryFilePath.length > 0, 'sidebarCategoryFilePath is required');
198
121
  }
199
122
  selectMultiConfiguration(multiConfigurations) {
@@ -205,13 +128,15 @@ export class CliOptions {
205
128
  }
206
129
  }
207
130
  else {
208
- configurationOptions = multiConfigurations;
131
+ const multiConfig = multiConfigurations;
132
+ configurationOptions =
133
+ 'default' in multiConfig
134
+ ? multiConfig.default
135
+ : multiConfigurations;
209
136
  }
210
137
  return configurationOptions;
211
138
  }
212
139
  }
213
- // Was used during development. Now stick to true.
214
140
  export const renderParagraphs = true;
215
141
  export const maxParallelPromises = 42;
216
- // ----------------------------------------------------------------------------
217
142
  //# sourceMappingURL=cli-options.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"cli-options.js","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,+EAA+E;AAE/E,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAgCjC;;;;GAIG;AACH,MAAM,OAAO,UAAU;IACrB;;;OAGG;IACH,yBAAyB,GAAG,aAAa,CAAA;IAEzC;;;OAGG;IACH,cAAc,GAAG,MAAM,CAAA;IAEvB,yEAAyE;IACzE,aAAa,GAAG,KAAK,CAAA;IAErB,sCAAsC;IACtC,OAAO,GAAG,GAAG,CAAA;IAEb,4EAA4E;IAC5E,WAAW,GAAG,MAAM,CAAA;IAEpB,4EAA4E;IAC5E,UAAU,GAAG,KAAK,CAAA;IAElB,2BAA2B;IAC3B,gBAAgB,GAAG,aAAa,CAAA;IAEhC,0EAA0E;IAC1E,sCAAsC,CAAqB;IAE3D,kDAAkD;IAClD,aAAa,GAAG,EAAE,CAAA;IAElB;;;OAGG;IACH,uBAAuB,GAAG,+BAA+B,CAAA;IAEzD,iDAAiD;IACjD,oBAAoB,GAAG,yBAAyB,CAAA;IAEhD;;;OAGG;IACH,oBAAoB,GAAG,qCAAqC,CAAA;IAE5D,8CAA8C;IAC9C,iBAAiB,GAAG,WAAW,CAAA;IAE/B;;;OAGG;IACH,iBAAiB,GAAG,uCAAuC,CAAA;IAE3D,oCAAoC;IACpC,OAAO,GAAG,KAAK,CAAA;IAEf,0CAA0C;IAC1C,KAAK,GAAG,KAAK,CAAA;IAEb,4DAA4D;IAC5D,uBAAuB,GAAG,KAAK,CAAA;IAE/B,8CAA8C;IAC9C,gBAAgB,GAAG,IAAI,CAAA;IAEvB,+DAA+D;IAC/D,oBAAoB,GAAG,IAAI,CAAA;IAE3B;;OAEG;IACH,0BAA0B,GAAG,IAAI,CAAA;IAEjC;;;;;;;;OAQG;IACH,iBAAiB,GAAG,EAAE,CAAA;IAEtB,uDAAuD;IACvD,EAAE,GAAG,SAAS,CAAA;IAEd,YAAY,cAA8B;QACxC,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,EAAY,CAAA;QAErC,IAAI,cAAc,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,EAAE,CAAA;YAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAA;YACzB,IAAI,CAAC,gBAAgB,GAAG,eAAe,IAAI,CAAC,EAAE,EAAE,CAAA;YAChD,IAAI,CAAC,uBAAuB;gBAC1B,0BAA0B,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;YACjD,IAAI,CAAC,oBAAoB;gBACvB,kCAAkC,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;QAC3D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAA;YACrC,IAAI,CAAC,uBAAuB,GAAG,+BAA+B,CAAA;YAC9D,IAAI,CAAC,oBAAoB,GAAG,uCAAuC,CAAA;QACrE,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QAEzE,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,QAAQ,EACR,yBAAyB,CAC1B,CAAA;YACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;YAEjE,mEAAmE;YACnE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAEvE,oBAAoB,GAAG,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;YACzE,6DAA6D;QAC/D,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,4BAA4B;QAC9B,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,yBAAyB,CAC1B,CAAA;gBACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAEjE,mEAAmE;gBACnE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEvE,oBAAoB;oBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACpD,6DAA6D;YAC/D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,4BAA4B;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,oCAAoC;gBACpC,4CAA4C;gBAC5C,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAA;gBACvE,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAEjE,mEAAmE;gBACnE,MAAM,OAAO,GAAgC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEnE,MAAM,mBAAmB,GAIvB,OAAO,CAAC,MAAM,EAAE,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAA;gBAElE,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACtC,oBAAoB;wBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACtD,CAAC;gBACD,6DAA6D;YAC/D,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACb,4BAA4B;YAC9B,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;QACnC,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,oDAAoD;YACpD,MAAM,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;YAEvD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACpD,MAAM,KAAK,GAAY,oBAAoB,CAAC,GAAG,CAAC,CAAA;gBAChD,0BAA0B;gBAC1B,IAAI,KAAK,KAAK,SAAS,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,YAAY,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAA;oBAC3D,MAAM,QAAQ,GAAG,OAAO,YAAY,CAAA;oBACpC,MAAM,SAAS,GAAG,OAAO,KAAK,CAAA;oBAE9B,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;wBAC7C,SAAQ;oBACV,CAAC;oBAED,gCAAgC;oBAChC,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBAC3B,CAAC;wBAAC,IAAgC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,GAAG,EAAE,CAAA;YACb,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QAED,MAAM,CACJ,IAAI,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC,EACzC,uCAAuC,CACxC,CAAA;QAED,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,4BAA4B,CAAC,CAAA;QACpE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,2BAA2B,CAAC,CAAA;QAElE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,yBAAyB,CAAC,CAAA;QAC9D,+DAA+D;QAE/D,MAAM,CACJ,IAAI,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,EACvC,qCAAqC,CACtC,CAAA;IACH,CAAC;IAED,wBAAwB,CACtB,mBAAkE;QAElE,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QACzE,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,oBAAoB,GAClB,mBAID,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAEV,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACvC,oBAAoB,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;YACnC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,oBAAoB,GAAG,mBAA8C,CAAA;QACvE,CAAC;QACD,OAAO,oBAAoB,CAAA;IAC7B,CAAC;CACF;AAED,kDAAkD;AAClD,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAEpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAA;AAErC,+EAA+E"}
1
+ {"version":3,"file":"cli-options.js","sourceRoot":"","sources":["../../src/docusaurus/cli-options.ts"],"names":[],"mappings":"AAaA,OAAO,MAAM,MAAM,aAAa,CAAA;AAChC,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACtC,OAAO,KAAK,IAAI,MAAM,WAAW,CAAA;AAyEjC,MAAM,OAAO,UAAU;IAWrB,yBAAyB,GAAG,aAAa,CAAA;IAYzC,cAAc,GAAG,MAAM,CAAA;IAYvB,aAAa,GAAG,KAAK,CAAA;IAWrB,OAAO,GAAG,GAAG,CAAA;IAWb,WAAW,GAAG,MAAM,CAAA;IAWpB,UAAU,GAAG,KAAK,CAAA;IAWlB,gBAAgB,GAAG,uBAAuB,CAAA;IAU1C,sCAAsC,CAAqB;IAY3D,aAAa,GAAG,EAAE,CAAA;IAWlB,uBAAuB,GAAG,+BAA+B,CAAA;IAWzD,oBAAoB,GAAG,yBAAyB,CAAA;IAWhD,sBAAsB,GAAG,uCAAuC,CAAA;IAWhE,mBAAmB,GAAG,eAAe,CAAA;IAWrC,sBAAsB,GAAqB,MAAM,CAAA;IAYjD,iBAAiB,GAAG,uCAAuC,CAAA;IAW3D,OAAO,GAAG,KAAK,CAAA;IAWf,KAAK,GAAG,KAAK,CAAA;IAWb,uBAAuB,GAAG,KAAK,CAAA;IAW/B,cAAc,GAAG,IAAI,CAAA;IAWrB,oBAAoB,GAAG,IAAI,CAAA;IAW3B,0BAA0B,GAAG,IAAI,CAAA;IAWjC,iBAAiB,GAAG,EAAE,CAAA;IAYtB,EAAE,GAAG,SAAS,CAAA;IAad,YAAY,cAA8B;QACxC,IAAI,CAAC,EAAE,GAAG,cAAc,CAAC,EAAY,CAAA;QAErC,IAAI,cAAc,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACzC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,cAAc,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACnB,CAAC;QAED,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,EAAE,CAAA;YAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAA;YACzB,IAAI,CAAC,gBAAgB,GAAG,eAAe,IAAI,CAAC,EAAE,EAAE,CAAA;YAChD,IAAI,CAAC,uBAAuB;gBAC1B,0BAA0B,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;YACjD,IAAI,CAAC,sBAAsB;gBACzB,kCAAkC,GAAG,IAAI,IAAI,CAAC,EAAE,OAAO,CAAA;QAC3D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;YAC1B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;YACvB,IAAI,CAAC,gBAAgB,GAAG,aAAa,CAAA;YACrC,IAAI,CAAC,uBAAuB,GAAG,+BAA+B,CAAA;YAC9D,IAAI,CAAC,sBAAsB,GAAG,uCAAuC,CAAA;QACvE,CAAC;IACH,CAAC;IAaD,KAAK,CAAC,KAAK;QACT,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QAEzE,IAAI,CAAC;YACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,QAAQ,EACR,yBAAyB,CAC1B,CAAA;YACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;YAGjE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YAEvE,oBAAoB,GAAG,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;QAE3E,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;QAEf,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBACH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CACtC,OAAO,CAAC,GAAG,EAAE,EACb,yBAAyB,CAC1B,CAAA;gBACD,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAGjE,MAAM,mBAAmB,GAAwB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEvE,oBAAoB;oBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;YAEtD,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;YAEf,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC;gBAGH,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAA;gBACvE,MAAM,UAAU,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAAA;gBAGjE,MAAM,OAAO,GAAgC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;gBAEnE,MAAM,mBAAmB,GAIvB,OAAO,CAAC,MAAM,EAAE,kBAAkB,IAAI,OAAO,CAAC,kBAAkB,CAAA;gBAElE,IAAI,mBAAmB,KAAK,SAAS,EAAE,CAAC;oBACtC,oBAAoB;wBAClB,IAAI,CAAC,wBAAwB,CAAC,mBAAmB,CAAC,CAAA;gBACtD,CAAC;YAEH,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;YAEf,CAAC;QACH,CAAC;QAED,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAA;YACnC,CAAC;YAED,MAAM,cAAc,GAAG,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAA;YAEvD,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;gBACpD,MAAM,KAAK,GAAY,oBAAoB,CAAC,GAAG,CAAC,CAAA;gBAEhD,IAAI,KAAK,KAAK,SAAS,IAAI,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;oBACxD,MAAM,YAAY,GAAI,IAAgC,CAAC,GAAG,CAAC,CAAA;oBAC3D,MAAM,QAAQ,GAAG,OAAO,YAAY,CAAA;oBACpC,MAAM,SAAS,GAAG,OAAO,KAAK,CAAA;oBAG9B,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;wBACzB,SAAQ;oBACV,CAAC;oBAGD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;wBAC3B,CAAC;wBAAC,IAAgC,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;oBACjD,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACjB,OAAO,CAAC,GAAG,EAAE,CAAA;YACb,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QACnB,CAAC;QAED,MAAM,CACJ,IAAI,CAAC,yBAAyB,CAAC,MAAM,GAAG,CAAC,EACzC,uCAAuC,CACxC,CAAA;QAED,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,4BAA4B,CAAC,CAAA;QACpE,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,2BAA2B,CAAC,CAAA;QAElE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,yBAAyB,CAAC,CAAA;QAG9D,MAAM,CACJ,IAAI,CAAC,uBAAuB,CAAC,MAAM,GAAG,CAAC,EACvC,qCAAqC,CACtC,CAAA;IACH,CAAC;IAaD,wBAAwB,CACtB,mBAAkE;QAElE,IAAI,oBAAoB,GAAwC,SAAS,CAAA;QACzE,IAAI,IAAI,CAAC,EAAE,KAAK,SAAS,EAAE,CAAC;YAC1B,oBAAoB,GAClB,mBAID,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YAEV,IAAI,oBAAoB,KAAK,SAAS,EAAE,CAAC;gBACvC,oBAAoB,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAA;YACnC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,WAAW,GAAG,mBAA0C,CAAA;YAC9D,oBAAoB;gBAClB,SAAS,IAAI,WAAW;oBACtB,CAAC,CAAC,WAAW,CAAC,OAAO;oBACrB,CAAC,CAAE,mBAA+C,CAAA;QACxD,CAAC;QACD,OAAO,oBAAoB,CAAA;IAC7B,CAAC;CACF;AAGD,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAA;AAGpC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAA"}
@@ -1,5 +1,6 @@
1
1
  import { Workspace } from './workspace.js';
2
2
  import { CliOptions } from './cli-options.js';
3
+ import type { SidebarCategory, NavbarItem } from './types.js';
3
4
  import type { CompoundBase } from './view-model/compound-base-vm.js';
4
5
  export declare class DocusaurusGenerator {
5
6
  workspace: Workspace;
@@ -7,12 +8,14 @@ export declare class DocusaurusGenerator {
7
8
  constructor(workspace: Workspace);
8
9
  run(): Promise<number>;
9
10
  prepareOutputFolder(): Promise<void>;
10
- generateSidebarFile(): Promise<void>;
11
- generateMenuFile(): Promise<void>;
11
+ generateSidebarCategory(): SidebarCategory;
12
+ writeSidebarFile(sidebarCategory: SidebarCategory): Promise<void>;
13
+ generateNavbarItem(): NavbarItem;
14
+ writeNavbarFile(navbarItem: NavbarItem): Promise<void>;
12
15
  generateCollectionsIndexDotMdFiles(): Promise<void>;
13
16
  generateTopIndexDotMdFile(): Promise<void>;
14
- generatePerInitialsIndexMdFiles(): Promise<void>;
15
- generatePages(): Promise<void>;
17
+ generatePerInitialsIndexDotMdFiles(): Promise<void>;
18
+ generateMdFiles(): Promise<void>;
16
19
  generatePage(compound: CompoundBase): Promise<void>;
17
20
  generateCompatibilityRedirectFiles(): Promise<void>;
18
21
  private generateRedirectFile;
@@ -1 +1 @@
1
- {"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/docusaurus/generator.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAuB,MAAM,kBAAkB,CAAA;AAMlE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAKpE,qBAAa,mBAAmB;IAC9B,SAAS,EAAE,SAAS,CAAA;IAEpB,OAAO,EAAE,UAAU,CAAA;gBAIP,SAAS,EAAE,SAAS;IAQ1B,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAuCtB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IAiBpC,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA4CpC,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IAyDjC,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAYnD,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IA2E1C,+BAA+B,IAAI,OAAO,CAAC,IAAI,CAAC;IAYhD,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IA+C9B,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAkCnD,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;YA4G3C,oBAAoB;IAuC5B,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAyC1B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA0CtC"}
1
+ {"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../../src/docusaurus/generator.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC1C,OAAO,EAAE,UAAU,EAAuB,MAAM,kBAAkB,CAAA;AAClE,OAAO,KAAK,EAAE,eAAe,EAAe,UAAU,EAAE,MAAM,YAAY,CAAA;AAK1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kCAAkC,CAAA;AAiBpE,qBAAa,mBAAmB;IAE9B,SAAS,EAAE,SAAS,CAAA;IAGpB,OAAO,EAAE,UAAU,CAAA;gBAeP,SAAS,EAAE,SAAS;IAmB1B,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC;IAyDtB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC;IA4B1C,uBAAuB,IAAI,eAAe;IAwCpC,gBAAgB,CAAC,eAAe,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBvE,kBAAkB,IAAI,UAAU;IA8C1B,eAAe,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBtD,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBnD,yBAAyB,IAAI,OAAO,CAAC,IAAI,CAAC;IAoF1C,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;IAqBnD,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;IA0DhC,YAAY,CAAC,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IA2CnD,kCAAkC,IAAI,OAAO,CAAC,IAAI,CAAC;YA0H3C,oBAAoB;IAgD5B,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAkD1B,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;CA0CtC"}