@docusaurus/theme-classic 0.0.0-5028 → 0.0.0-5031

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 (327) hide show
  1. package/lib/getSwizzleConfig.d.ts +8 -0
  2. package/lib/getSwizzleConfig.js +226 -234
  3. package/lib/index.d.ts +12 -0
  4. package/lib/index.js +103 -155
  5. package/lib/nprogress.d.ts +10 -0
  6. package/lib/nprogress.js +16 -37
  7. package/lib/prism-include-languages.d.ts +7 -0
  8. package/lib/prism-include-languages.js +3 -9
  9. package/lib/theme/Admonition/index.d.ts +9 -0
  10. package/{lib-next → lib}/theme/Admonition/index.js +0 -0
  11. package/lib/theme/AnnouncementBar/index.d.ts +8 -0
  12. package/{lib-next → lib}/theme/AnnouncementBar/index.js +4 -10
  13. package/{lib-next → lib}/theme/AnnouncementBar/styles.module.css +0 -0
  14. package/lib/theme/BackToTopButton/index.d.ts +8 -0
  15. package/{lib-next → lib}/theme/BackToTopButton/index.js +1 -3
  16. package/{lib-next → lib}/theme/BackToTopButton/styles.module.css +0 -0
  17. package/lib/theme/BlogArchivePage/index.d.ts +10 -0
  18. package/{lib-next → lib}/theme/BlogArchivePage/index.js +0 -4
  19. package/lib/theme/BlogLayout/index.d.ts +9 -0
  20. package/{lib-next → lib}/theme/BlogLayout/index.js +0 -0
  21. package/lib/theme/BlogListPage/index.d.ts +10 -0
  22. package/{lib-next → lib}/theme/BlogListPage/index.js +0 -3
  23. package/lib/theme/BlogListPaginator/index.d.ts +9 -0
  24. package/{lib-next → lib}/theme/BlogListPaginator/index.js +0 -0
  25. package/lib/theme/BlogPostAuthor/index.d.ts +9 -0
  26. package/{lib-next → lib}/theme/BlogPostAuthor/index.js +0 -3
  27. package/lib/theme/BlogPostAuthors/index.d.ts +9 -0
  28. package/{lib-next → lib}/theme/BlogPostAuthors/index.js +2 -4
  29. package/{lib-next → lib}/theme/BlogPostAuthors/styles.module.css +0 -0
  30. package/lib/theme/BlogPostItem/index.d.ts +9 -0
  31. package/{lib-next → lib}/theme/BlogPostItem/index.js +8 -20
  32. package/{lib-next → lib}/theme/BlogPostItem/styles.module.css +0 -0
  33. package/lib/theme/BlogPostPage/index.d.ts +10 -0
  34. package/{lib-next → lib}/theme/BlogPostPage/index.js +0 -3
  35. package/lib/theme/BlogPostPaginator/index.d.ts +9 -0
  36. package/{lib-next → lib}/theme/BlogPostPaginator/index.js +0 -0
  37. package/lib/theme/BlogSidebar/Desktop/index.d.ts +9 -0
  38. package/{lib-next → lib}/theme/BlogSidebar/Desktop/index.js +0 -0
  39. package/{lib-next → lib}/theme/BlogSidebar/Desktop/styles.module.css +0 -0
  40. package/lib/theme/BlogSidebar/Mobile/index.d.ts +9 -0
  41. package/{lib-next → lib}/theme/BlogSidebar/Mobile/index.js +0 -2
  42. package/lib/theme/BlogSidebar/index.d.ts +9 -0
  43. package/{lib-next → lib}/theme/BlogSidebar/index.js +2 -4
  44. package/lib/theme/BlogTagsListPage/index.d.ts +10 -0
  45. package/{lib-next → lib}/theme/BlogTagsListPage/index.js +0 -0
  46. package/lib/theme/BlogTagsPostsPage/index.d.ts +10 -0
  47. package/{lib-next → lib}/theme/BlogTagsPostsPage/index.js +2 -9
  48. package/lib/theme/CodeBlock/Container/index.d.ts +10 -0
  49. package/{lib-next → lib}/theme/CodeBlock/Container/index.js +2 -1
  50. package/{lib-next → lib}/theme/CodeBlock/Container/styles.module.css +0 -0
  51. package/lib/theme/CodeBlock/Content/Element.d.ts +9 -0
  52. package/{lib-next → lib}/theme/CodeBlock/Content/Element.js +2 -2
  53. package/lib/theme/CodeBlock/Content/String.d.ts +9 -0
  54. package/{lib-next → lib}/theme/CodeBlock/Content/String.js +2 -2
  55. package/{lib-next → lib}/theme/CodeBlock/Content/styles.module.css +0 -0
  56. package/lib/theme/CodeBlock/CopyButton/index.d.ts +9 -0
  57. package/{lib-next → lib}/theme/CodeBlock/CopyButton/index.js +0 -0
  58. package/{lib-next → lib}/theme/CodeBlock/CopyButton/styles.module.css +0 -0
  59. package/lib/theme/CodeBlock/Line/index.d.ts +9 -0
  60. package/{lib-next → lib}/theme/CodeBlock/Line/index.js +1 -8
  61. package/{lib-next → lib}/theme/CodeBlock/Line/styles.module.css +0 -0
  62. package/lib/theme/CodeBlock/WordWrapButton/index.d.ts +9 -0
  63. package/{lib-next → lib}/theme/CodeBlock/WordWrapButton/index.js +0 -0
  64. package/{lib-next → lib}/theme/CodeBlock/WordWrapButton/styles.module.css +0 -0
  65. package/lib/theme/CodeBlock/index.d.ts +9 -0
  66. package/{lib-next → lib}/theme/CodeBlock/index.js +2 -4
  67. package/lib/theme/ColorModeToggle/index.d.ts +11 -0
  68. package/{lib-next → lib}/theme/ColorModeToggle/index.js +0 -2
  69. package/{lib-next → lib}/theme/ColorModeToggle/styles.module.css +0 -0
  70. package/lib/theme/Details/index.d.ts +9 -0
  71. package/{lib-next → lib}/theme/Details/index.js +2 -2
  72. package/{lib-next → lib}/theme/Details/styles.module.css +0 -0
  73. package/lib/theme/DocBreadcrumbs/index.d.ts +8 -0
  74. package/{lib-next → lib}/theme/DocBreadcrumbs/index.js +6 -11
  75. package/{lib-next → lib}/theme/DocBreadcrumbs/styles.module.css +0 -0
  76. package/lib/theme/DocCard/index.d.ts +9 -0
  77. package/{lib-next → lib}/theme/DocCard/index.js +3 -13
  78. package/{lib-next → lib}/theme/DocCard/styles.module.css +0 -0
  79. package/lib/theme/DocCardList/index.d.ts +9 -0
  80. package/{lib-next → lib}/theme/DocCardList/index.js +0 -3
  81. package/lib/theme/DocCategoryGeneratedIndexPage/index.d.ts +10 -0
  82. package/{lib-next → lib}/theme/DocCategoryGeneratedIndexPage/index.js +4 -5
  83. package/{lib-next → lib}/theme/DocCategoryGeneratedIndexPage/styles.module.css +0 -0
  84. package/lib/theme/DocItem/index.d.ts +10 -0
  85. package/{lib-next → lib}/theme/DocItem/index.js +8 -20
  86. package/{lib-next → lib}/theme/DocItem/styles.module.css +0 -0
  87. package/lib/theme/DocItemFooter/index.d.ts +10 -0
  88. package/{lib-next → lib}/theme/DocItemFooter/index.js +0 -5
  89. package/{lib-next → lib}/theme/DocItemFooter/styles.module.css +0 -0
  90. package/lib/theme/DocPage/Layout/Main/index.d.ts +9 -0
  91. package/{lib-next → lib}/theme/DocPage/Layout/Main/index.js +0 -0
  92. package/{lib-next → lib}/theme/DocPage/Layout/Main/styles.module.css +0 -0
  93. package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/index.d.ts +9 -0
  94. package/{lib-next → lib}/theme/DocPage/Layout/Sidebar/ExpandButton/index.js +0 -0
  95. package/{lib-next → lib}/theme/DocPage/Layout/Sidebar/ExpandButton/styles.module.css +0 -0
  96. package/lib/theme/DocPage/Layout/Sidebar/index.d.ts +9 -0
  97. package/{lib-next → lib}/theme/DocPage/Layout/Sidebar/index.js +2 -5
  98. package/{lib-next → lib}/theme/DocPage/Layout/Sidebar/styles.module.css +0 -0
  99. package/lib/theme/DocPage/Layout/index.d.ts +9 -0
  100. package/{lib-next → lib}/theme/DocPage/Layout/index.js +0 -0
  101. package/{lib-next → lib}/theme/DocPage/Layout/styles.module.css +0 -0
  102. package/lib/theme/DocPage/index.d.ts +10 -0
  103. package/{lib-next → lib}/theme/DocPage/index.js +0 -2
  104. package/lib/theme/DocPaginator/index.d.ts +9 -0
  105. package/{lib-next → lib}/theme/DocPaginator/index.js +0 -0
  106. package/lib/theme/DocSidebar/Desktop/CollapseButton/index.d.ts +9 -0
  107. package/{lib-next → lib}/theme/DocSidebar/Desktop/CollapseButton/index.js +0 -0
  108. package/{lib-next → lib}/theme/DocSidebar/Desktop/CollapseButton/styles.module.css +0 -0
  109. package/lib/theme/DocSidebar/Desktop/Content/index.d.ts +9 -0
  110. package/{lib-next → lib}/theme/DocSidebar/Desktop/Content/index.js +0 -2
  111. package/{lib-next → lib}/theme/DocSidebar/Desktop/Content/styles.module.css +0 -0
  112. package/lib/theme/DocSidebar/Desktop/index.d.ts +11 -0
  113. package/{lib-next → lib}/theme/DocSidebar/Desktop/index.js +0 -2
  114. package/{lib-next → lib}/theme/DocSidebar/Desktop/styles.module.css +0 -0
  115. package/lib/theme/DocSidebar/Mobile/index.d.ts +11 -0
  116. package/{lib-next → lib}/theme/DocSidebar/Mobile/index.js +0 -4
  117. package/lib/theme/DocSidebar/index.d.ts +9 -0
  118. package/{lib-next → lib}/theme/DocSidebar/index.js +4 -4
  119. package/lib/theme/DocSidebarItem/Category/index.d.ts +9 -0
  120. package/{lib-next → lib}/theme/DocSidebarItem/Category/index.js +6 -21
  121. package/lib/theme/DocSidebarItem/Html/index.d.ts +9 -0
  122. package/{lib-next → lib}/theme/DocSidebarItem/Html/index.js +3 -4
  123. package/{lib-next → lib}/theme/DocSidebarItem/Html/styles.module.css +0 -0
  124. package/lib/theme/DocSidebarItem/Link/index.d.ts +9 -0
  125. package/{lib-next → lib}/theme/DocSidebarItem/Link/index.js +0 -0
  126. package/{lib-next → lib}/theme/DocSidebarItem/Link/styles.module.css +0 -0
  127. package/lib/theme/DocSidebarItem/index.d.ts +9 -0
  128. package/{lib-next → lib}/theme/DocSidebarItem/index.js +0 -2
  129. package/lib/theme/DocSidebarItems/index.d.ts +11 -0
  130. package/{lib-next → lib}/theme/DocSidebarItems/index.js +2 -3
  131. package/lib/theme/DocTagDocListPage/index.d.ts +10 -0
  132. package/{lib-next → lib}/theme/DocTagDocListPage/index.js +2 -10
  133. package/lib/theme/DocTagsListPage/index.d.ts +10 -0
  134. package/{lib-next → lib}/theme/DocTagsListPage/index.js +0 -0
  135. package/lib/theme/DocVersionBadge/index.d.ts +9 -0
  136. package/{lib-next → lib}/theme/DocVersionBadge/index.js +1 -5
  137. package/lib/theme/DocVersionBanner/index.d.ts +9 -0
  138. package/{lib-next → lib}/theme/DocVersionBanner/index.js +3 -16
  139. package/lib/theme/EditThisPage/index.d.ts +9 -0
  140. package/{lib-next → lib}/theme/EditThisPage/index.js +0 -0
  141. package/lib/theme/ErrorPageContent.d.ts +10 -0
  142. package/{lib-next → lib}/theme/ErrorPageContent.js +0 -0
  143. package/lib/theme/Footer/Copyright/index.d.ts +9 -0
  144. package/{lib-next → lib}/theme/Footer/Copyright/index.js +3 -4
  145. package/lib/theme/Footer/Layout/index.d.ts +9 -0
  146. package/{lib-next → lib}/theme/Footer/Layout/index.js +0 -0
  147. package/lib/theme/Footer/LinkItem/index.d.ts +9 -0
  148. package/{lib-next → lib}/theme/Footer/LinkItem/index.js +1 -3
  149. package/lib/theme/Footer/Links/MultiColumn/index.d.ts +9 -0
  150. package/{lib-next → lib}/theme/Footer/Links/MultiColumn/index.js +3 -7
  151. package/lib/theme/Footer/Links/Simple/index.d.ts +9 -0
  152. package/{lib-next → lib}/theme/Footer/Links/Simple/index.js +3 -7
  153. package/lib/theme/Footer/Links/index.d.ts +9 -0
  154. package/{lib-next → lib}/theme/Footer/Links/index.js +0 -0
  155. package/lib/theme/Footer/Logo/index.d.ts +9 -0
  156. package/{lib-next → lib}/theme/Footer/Logo/index.js +0 -2
  157. package/{lib-next → lib}/theme/Footer/Logo/styles.module.css +0 -0
  158. package/lib/theme/Footer/index.d.ts +10 -0
  159. package/{lib-next → lib}/theme/Footer/index.js +0 -4
  160. package/lib/theme/Heading/index.d.ts +9 -0
  161. package/{lib-next → lib}/theme/Heading/index.js +2 -3
  162. package/{lib-next → lib}/theme/Heading/styles.module.css +0 -0
  163. package/lib/theme/IconArrow/index.d.ts +9 -0
  164. package/{lib-next → lib}/theme/IconArrow/index.js +0 -0
  165. package/lib/theme/IconClose/index.d.ts +9 -0
  166. package/{lib-next → lib}/theme/IconClose/index.js +0 -0
  167. package/lib/theme/IconDarkMode/index.d.ts +9 -0
  168. package/{lib-next → lib}/theme/IconDarkMode/index.js +0 -0
  169. package/lib/theme/IconEdit/index.d.ts +9 -0
  170. package/{lib-next → lib}/theme/IconEdit/index.js +0 -0
  171. package/{lib-next → lib}/theme/IconEdit/styles.module.css +0 -0
  172. package/lib/theme/IconExternalLink/index.d.ts +9 -0
  173. package/{lib-next → lib}/theme/IconExternalLink/index.js +0 -0
  174. package/{lib-next → lib}/theme/IconExternalLink/styles.module.css +0 -0
  175. package/lib/theme/IconHome/index.d.ts +9 -0
  176. package/{lib-next → lib}/theme/IconHome/index.js +0 -0
  177. package/lib/theme/IconLanguage/index.d.ts +9 -0
  178. package/{lib-next → lib}/theme/IconLanguage/index.js +0 -0
  179. package/lib/theme/IconLightMode/index.d.ts +9 -0
  180. package/{lib-next → lib}/theme/IconLightMode/index.js +0 -0
  181. package/lib/theme/IconMenu/index.d.ts +9 -0
  182. package/{lib-next → lib}/theme/IconMenu/index.js +0 -0
  183. package/lib/theme/LastUpdated/index.d.ts +9 -0
  184. package/{lib-next → lib}/theme/LastUpdated/index.js +0 -3
  185. package/lib/theme/Layout/index.d.ts +10 -0
  186. package/{lib-next → lib}/theme/Layout/index.js +0 -0
  187. package/{lib-next → lib}/theme/Layout/styles.css +0 -0
  188. package/lib/theme/LayoutProviders/index.d.ts +9 -0
  189. package/{lib-next → lib}/theme/LayoutProviders/index.js +0 -0
  190. package/lib/theme/Logo/index.d.ts +9 -0
  191. package/{lib-next → lib}/theme/Logo/index.js +2 -9
  192. package/lib/theme/MDXComponents/A.d.ts +9 -0
  193. package/{lib-next → lib}/theme/MDXComponents/A.js +0 -0
  194. package/lib/theme/MDXComponents/Code.d.ts +9 -0
  195. package/{lib-next → lib}/theme/MDXComponents/Code.js +0 -0
  196. package/lib/theme/MDXComponents/Details.d.ts +9 -0
  197. package/{lib-next → lib}/theme/MDXComponents/Details.js +2 -2
  198. package/lib/theme/MDXComponents/Head.d.ts +9 -0
  199. package/{lib-next → lib}/theme/MDXComponents/Head.js +0 -3
  200. package/lib/theme/MDXComponents/Heading.d.ts +9 -0
  201. package/{lib-next → lib}/theme/MDXComponents/Heading.js +0 -0
  202. package/lib/theme/MDXComponents/Img/index.d.ts +9 -0
  203. package/{lib-next → lib}/theme/MDXComponents/Img/index.js +0 -2
  204. package/{lib-next → lib}/theme/MDXComponents/Img/styles.module.css +0 -0
  205. package/lib/theme/MDXComponents/Pre.d.ts +9 -0
  206. package/{lib-next → lib}/theme/MDXComponents/Pre.js +2 -1
  207. package/lib/theme/MDXComponents/Ul.d.ts +9 -0
  208. package/{lib-next → lib}/theme/MDXComponents/Ul.js +2 -3
  209. package/lib/theme/MDXComponents/index.d.ts +9 -0
  210. package/{lib-next → lib}/theme/MDXComponents/index.js +0 -0
  211. package/lib/theme/MDXContent/index.d.ts +9 -0
  212. package/{lib-next → lib}/theme/MDXContent/index.js +0 -0
  213. package/lib/theme/MDXPage/index.d.ts +10 -0
  214. package/{lib-next → lib}/theme/MDXPage/index.js +0 -0
  215. package/{lib-next → lib}/theme/MDXPage/styles.module.css +0 -0
  216. package/lib/theme/Navbar/ColorModeToggle/index.d.ts +9 -0
  217. package/{lib-next → lib}/theme/Navbar/ColorModeToggle/index.js +0 -2
  218. package/lib/theme/Navbar/Content/index.d.ts +8 -0
  219. package/{lib-next → lib}/theme/Navbar/Content/index.js +0 -4
  220. package/{lib-next → lib}/theme/Navbar/Content/styles.module.css +0 -0
  221. package/lib/theme/Navbar/Layout/index.d.ts +9 -0
  222. package/{lib-next → lib}/theme/Navbar/Layout/index.js +0 -2
  223. package/{lib-next → lib}/theme/Navbar/Layout/styles.module.css +0 -0
  224. package/lib/theme/Navbar/Logo/index.d.ts +8 -0
  225. package/{lib-next → lib}/theme/Navbar/Logo/index.js +0 -0
  226. package/lib/theme/Navbar/MobileSidebar/Header/index.d.ts +8 -0
  227. package/{lib-next → lib}/theme/Navbar/MobileSidebar/Header/index.js +0 -2
  228. package/lib/theme/Navbar/MobileSidebar/Layout/index.d.ts +9 -0
  229. package/{lib-next → lib}/theme/Navbar/MobileSidebar/Layout/index.js +0 -0
  230. package/lib/theme/Navbar/MobileSidebar/PrimaryMenu/index.d.ts +8 -0
  231. package/{lib-next → lib}/theme/Navbar/MobileSidebar/PrimaryMenu/index.js +4 -5
  232. package/lib/theme/Navbar/MobileSidebar/SecondaryMenu/index.d.ts +8 -0
  233. package/{lib-next → lib}/theme/Navbar/MobileSidebar/SecondaryMenu/index.js +2 -3
  234. package/lib/theme/Navbar/MobileSidebar/Toggle/index.d.ts +8 -0
  235. package/{lib-next → lib}/theme/Navbar/MobileSidebar/Toggle/index.js +0 -0
  236. package/lib/theme/Navbar/MobileSidebar/index.d.ts +8 -0
  237. package/{lib-next → lib}/theme/Navbar/MobileSidebar/index.js +0 -2
  238. package/lib/theme/Navbar/Search/index.d.ts +9 -0
  239. package/{lib-next → lib}/theme/Navbar/Search/index.js +0 -0
  240. package/{lib-next → lib}/theme/Navbar/Search/styles.module.css +0 -0
  241. package/lib/theme/Navbar/index.d.ts +8 -0
  242. package/{lib-next → lib}/theme/Navbar/index.js +0 -0
  243. package/lib/theme/NavbarItem/ComponentTypes.d.ts +9 -0
  244. package/{lib-next → lib}/theme/NavbarItem/ComponentTypes.js +0 -0
  245. package/lib/theme/NavbarItem/DefaultNavbarItem.d.ts +10 -0
  246. package/{lib-next → lib}/theme/NavbarItem/DefaultNavbarItem.js +1 -7
  247. package/lib/theme/NavbarItem/DocNavbarItem.d.ts +9 -0
  248. package/{lib-next → lib}/theme/NavbarItem/DocNavbarItem.js +3 -4
  249. package/lib/theme/NavbarItem/DocSidebarNavbarItem.d.ts +9 -0
  250. package/{lib-next → lib}/theme/NavbarItem/DocSidebarNavbarItem.js +0 -2
  251. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.d.ts +9 -0
  252. package/{lib-next → lib}/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +4 -7
  253. package/lib/theme/NavbarItem/DocsVersionNavbarItem.d.ts +9 -0
  254. package/{lib-next → lib}/theme/NavbarItem/DocsVersionNavbarItem.js +0 -2
  255. package/lib/theme/NavbarItem/DropdownNavbarItem.d.ts +9 -0
  256. package/{lib-next → lib}/theme/NavbarItem/DropdownNavbarItem.js +6 -17
  257. package/lib/theme/NavbarItem/HtmlNavbarItem.d.ts +9 -0
  258. package/{lib-next → lib}/theme/NavbarItem/HtmlNavbarItem.js +1 -3
  259. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/index.d.ts +9 -0
  260. package/{lib-next → lib}/theme/NavbarItem/LocaleDropdownNavbarItem/index.js +2 -2
  261. package/{lib-next → lib}/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +0 -0
  262. package/lib/theme/NavbarItem/NavbarNavLink.d.ts +9 -0
  263. package/{lib-next → lib}/theme/NavbarItem/NavbarNavLink.js +5 -16
  264. package/lib/theme/NavbarItem/SearchNavbarItem.d.ts +9 -0
  265. package/{lib-next → lib}/theme/NavbarItem/SearchNavbarItem.js +0 -1
  266. package/lib/theme/NavbarItem/index.d.ts +9 -0
  267. package/{lib-next → lib}/theme/NavbarItem/index.js +0 -6
  268. package/lib/theme/NavbarItem/utils.d.ts +7 -0
  269. package/{lib-next → lib}/theme/NavbarItem/utils.js +0 -1
  270. package/lib/theme/NotFound.d.ts +8 -0
  271. package/{lib-next → lib}/theme/NotFound.js +0 -0
  272. package/lib/theme/PaginatorNavLink/index.d.ts +9 -0
  273. package/{lib-next → lib}/theme/PaginatorNavLink/index.js +0 -0
  274. package/lib/theme/SearchBar.d.ts +7 -0
  275. package/{lib-next → lib}/theme/SearchBar.js +0 -0
  276. package/lib/theme/SearchMetadata/index.d.ts +9 -0
  277. package/{lib-next → lib}/theme/SearchMetadata/index.js +3 -3
  278. package/lib/theme/SiteMetadata/index.d.ts +8 -0
  279. package/{lib-next → lib}/theme/SiteMetadata/index.js +15 -16
  280. package/lib/theme/SkipToContent/index.d.ts +8 -0
  281. package/{lib-next → lib}/theme/SkipToContent/index.js +0 -0
  282. package/{lib-next → lib}/theme/SkipToContent/styles.module.css +0 -0
  283. package/lib/theme/TOC/index.d.ts +9 -0
  284. package/{lib-next → lib}/theme/TOC/index.js +2 -2
  285. package/{lib-next → lib}/theme/TOC/styles.module.css +0 -0
  286. package/lib/theme/TOCCollapsible/CollapseButton/index.d.ts +9 -0
  287. package/{lib-next → lib}/theme/TOCCollapsible/CollapseButton/index.js +0 -0
  288. package/{lib-next → lib}/theme/TOCCollapsible/CollapseButton/styles.module.css +0 -0
  289. package/lib/theme/TOCCollapsible/index.d.ts +9 -0
  290. package/{lib-next → lib}/theme/TOCCollapsible/index.js +0 -0
  291. package/{lib-next → lib}/theme/TOCCollapsible/styles.module.css +0 -0
  292. package/lib/theme/TOCInline/index.d.ts +9 -0
  293. package/{lib-next → lib}/theme/TOCInline/index.js +0 -0
  294. package/{lib-next → lib}/theme/TOCInline/styles.module.css +0 -0
  295. package/lib/theme/TOCItems/Tree.d.ts +11 -0
  296. package/{lib-next → lib}/theme/TOCItems/Tree.js +5 -8
  297. package/lib/theme/TOCItems/index.d.ts +9 -0
  298. package/{lib-next → lib}/theme/TOCItems/index.js +0 -1
  299. package/lib/theme/TabItem/index.d.ts +9 -0
  300. package/{lib-next → lib}/theme/TabItem/index.js +1 -3
  301. package/{lib-next → lib}/theme/TabItem/styles.module.css +0 -0
  302. package/lib/theme/Tabs/index.d.ts +9 -0
  303. package/{lib-next → lib}/theme/Tabs/index.js +11 -27
  304. package/{lib-next → lib}/theme/Tabs/styles.module.css +0 -0
  305. package/lib/theme/Tag/index.d.ts +9 -0
  306. package/{lib-next → lib}/theme/Tag/index.js +0 -0
  307. package/{lib-next → lib}/theme/Tag/styles.module.css +0 -0
  308. package/lib/theme/TagsListByLetter/index.d.ts +9 -0
  309. package/{lib-next → lib}/theme/TagsListByLetter/index.js +0 -2
  310. package/{lib-next → lib}/theme/TagsListByLetter/styles.module.css +0 -0
  311. package/lib/theme/TagsListInline/index.d.ts +9 -0
  312. package/{lib-next → lib}/theme/TagsListInline/index.js +0 -0
  313. package/{lib-next → lib}/theme/TagsListInline/styles.module.css +0 -0
  314. package/lib/theme/ThemedImage/index.d.ts +9 -0
  315. package/{lib-next → lib}/theme/ThemedImage/index.js +3 -2
  316. package/{lib-next → lib}/theme/ThemedImage/styles.module.css +0 -0
  317. package/lib/theme/prism-include-languages.d.ts +8 -0
  318. package/{lib-next → lib}/theme/prism-include-languages.js +2 -2
  319. package/lib/translations.d.ts +15 -0
  320. package/lib/translations.js +120 -136
  321. package/lib/validateThemeConfig.d.ts +68 -0
  322. package/lib/validateThemeConfig.js +353 -322
  323. package/package.json +19 -23
  324. package/src/index.ts +1 -1
  325. package/lib/deps.d.ts +0 -13
  326. package/lib/theme-classic.d.ts +0 -1279
  327. package/lib-next/theme/Tabs/__tests__/index.test.js +0 -146
@@ -1,367 +1,398 @@
1
1
  "use strict";
2
-
3
- Object.defineProperty(exports, "__esModule", {
4
- value: true
5
- });
6
- exports.ThemeConfigSchema = exports.DEFAULT_CONFIG = void 0;
7
- exports.validateThemeConfig = validateThemeConfig;
8
-
9
- var _palenight = _interopRequireDefault(require("prism-react-renderer/themes/palenight"));
10
-
11
- var _utilsValidation = require("@docusaurus/utils-validation");
12
-
13
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
14
-
15
2
  /**
16
3
  * Copyright (c) Facebook, Inc. and its affiliates.
17
4
  *
18
5
  * This source code is licensed under the MIT license found in the
19
6
  * LICENSE file in the root directory of this source tree.
20
7
  */
8
+ Object.defineProperty(exports, "__esModule", { value: true });
9
+ exports.validateThemeConfig = exports.ThemeConfigSchema = exports.DEFAULT_CONFIG = void 0;
10
+ const tslib_1 = require("tslib");
11
+ const palenight_1 = tslib_1.__importDefault(require("prism-react-renderer/themes/palenight"));
12
+ const utils_validation_1 = require("@docusaurus/utils-validation");
21
13
  const DEFAULT_DOCS_CONFIG = {
22
- versionPersistence: 'localStorage',
23
- sidebar: {
24
- hideable: false,
25
- autoCollapseCategories: false
26
- }
14
+ versionPersistence: 'localStorage',
15
+ sidebar: {
16
+ hideable: false,
17
+ autoCollapseCategories: false,
18
+ },
27
19
  };
28
-
29
- const DocsSchema = _utilsValidation.Joi.object({
30
- versionPersistence: _utilsValidation.Joi.string().equal('localStorage', 'none').default(DEFAULT_DOCS_CONFIG.versionPersistence),
31
- sidebar: _utilsValidation.Joi.object({
32
- hideable: _utilsValidation.Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.hideable),
33
- autoCollapseCategories: _utilsValidation.Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.autoCollapseCategories)
34
- }).default(DEFAULT_DOCS_CONFIG.sidebar)
20
+ const DocsSchema = utils_validation_1.Joi.object({
21
+ versionPersistence: utils_validation_1.Joi.string()
22
+ .equal('localStorage', 'none')
23
+ .default(DEFAULT_DOCS_CONFIG.versionPersistence),
24
+ sidebar: utils_validation_1.Joi.object({
25
+ hideable: utils_validation_1.Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.hideable),
26
+ autoCollapseCategories: utils_validation_1.Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.autoCollapseCategories),
27
+ }).default(DEFAULT_DOCS_CONFIG.sidebar),
35
28
  }).default(DEFAULT_DOCS_CONFIG);
36
-
37
29
  const DEFAULT_COLOR_MODE_CONFIG = {
38
- defaultMode: 'light',
39
- disableSwitch: false,
40
- respectPrefersColorScheme: false
30
+ defaultMode: 'light',
31
+ disableSwitch: false,
32
+ respectPrefersColorScheme: false,
41
33
  };
42
- const DEFAULT_CONFIG = {
43
- colorMode: DEFAULT_COLOR_MODE_CONFIG,
44
- docs: DEFAULT_DOCS_CONFIG,
45
- metadata: [],
46
- prism: {
47
- additionalLanguages: [],
48
- theme: _palenight.default,
49
- magicComments: [{
50
- className: 'theme-code-block-highlighted-line',
51
- line: 'highlight-next-line',
52
- block: {
53
- start: 'highlight-start',
54
- end: 'highlight-end'
55
- }
56
- }]
57
- },
58
- navbar: {
59
- hideOnScroll: false,
60
- items: []
61
- },
62
- tableOfContents: {
63
- minHeadingLevel: 2,
64
- maxHeadingLevel: 3
65
- }
34
+ exports.DEFAULT_CONFIG = {
35
+ colorMode: DEFAULT_COLOR_MODE_CONFIG,
36
+ docs: DEFAULT_DOCS_CONFIG,
37
+ metadata: [],
38
+ prism: {
39
+ additionalLanguages: [],
40
+ theme: palenight_1.default,
41
+ magicComments: [
42
+ {
43
+ className: 'theme-code-block-highlighted-line',
44
+ line: 'highlight-next-line',
45
+ block: { start: 'highlight-start', end: 'highlight-end' },
46
+ },
47
+ ],
48
+ },
49
+ navbar: {
50
+ hideOnScroll: false,
51
+ items: [],
52
+ },
53
+ tableOfContents: {
54
+ minHeadingLevel: 2,
55
+ maxHeadingLevel: 3,
56
+ },
66
57
  };
67
- exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
68
-
69
- const NavbarItemPosition = _utilsValidation.Joi.string().equal('left', 'right').default('left');
70
-
71
- const NavbarItemBaseSchema = _utilsValidation.Joi.object({
72
- label: _utilsValidation.Joi.string(),
73
- html: _utilsValidation.Joi.string(),
74
- className: _utilsValidation.Joi.string()
75
- }).nand('html', 'label') // We allow any unknown attributes on the links (users may need additional
76
- // attributes like target, aria-role, data-customAttribute...)
77
- .unknown();
78
-
58
+ const NavbarItemPosition = utils_validation_1.Joi.string().equal('left', 'right').default('left');
59
+ const NavbarItemBaseSchema = utils_validation_1.Joi.object({
60
+ label: utils_validation_1.Joi.string(),
61
+ html: utils_validation_1.Joi.string(),
62
+ className: utils_validation_1.Joi.string(),
63
+ })
64
+ .nand('html', 'label')
65
+ // We allow any unknown attributes on the links (users may need additional
66
+ // attributes like target, aria-role, data-customAttribute...)
67
+ .unknown();
79
68
  const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
80
- to: _utilsValidation.Joi.string(),
81
- href: _utilsValidation.URISchema,
82
- activeBasePath: _utilsValidation.Joi.string(),
83
- activeBaseRegex: _utilsValidation.Joi.string(),
84
- prependBaseUrlToHref: _utilsValidation.Joi.bool(),
85
- // This is only triggered in case of a nested dropdown
86
- items: _utilsValidation.Joi.forbidden().messages({
87
- 'any.unknown': 'Nested dropdowns are not allowed'
88
- })
89
- }).xor('href', 'to').messages({
90
- 'object.xor': 'One and only one between "to" and "href" should be provided'
69
+ to: utils_validation_1.Joi.string(),
70
+ href: utils_validation_1.URISchema,
71
+ activeBasePath: utils_validation_1.Joi.string(),
72
+ activeBaseRegex: utils_validation_1.Joi.string(),
73
+ prependBaseUrlToHref: utils_validation_1.Joi.bool(),
74
+ // This is only triggered in case of a nested dropdown
75
+ items: utils_validation_1.Joi.forbidden().messages({
76
+ 'any.unknown': 'Nested dropdowns are not allowed',
77
+ }),
78
+ })
79
+ .xor('href', 'to')
80
+ .messages({
81
+ 'object.xor': 'One and only one between "to" and "href" should be provided',
91
82
  });
92
83
  const DocsVersionNavbarItemSchema = NavbarItemBaseSchema.append({
93
- type: _utilsValidation.Joi.string().equal('docsVersion').required(),
94
- to: _utilsValidation.Joi.string(),
95
- docsPluginId: _utilsValidation.Joi.string()
84
+ type: utils_validation_1.Joi.string().equal('docsVersion').required(),
85
+ to: utils_validation_1.Joi.string(),
86
+ docsPluginId: utils_validation_1.Joi.string(),
96
87
  });
97
88
  const DocItemSchema = NavbarItemBaseSchema.append({
98
- type: _utilsValidation.Joi.string().equal('doc').required(),
99
- docId: _utilsValidation.Joi.string().required(),
100
- docsPluginId: _utilsValidation.Joi.string()
89
+ type: utils_validation_1.Joi.string().equal('doc').required(),
90
+ docId: utils_validation_1.Joi.string().required(),
91
+ docsPluginId: utils_validation_1.Joi.string(),
101
92
  });
102
93
  const DocSidebarItemSchema = NavbarItemBaseSchema.append({
103
- type: _utilsValidation.Joi.string().equal('docSidebar').required(),
104
- sidebarId: _utilsValidation.Joi.string().required(),
105
- docsPluginId: _utilsValidation.Joi.string()
94
+ type: utils_validation_1.Joi.string().equal('docSidebar').required(),
95
+ sidebarId: utils_validation_1.Joi.string().required(),
96
+ docsPluginId: utils_validation_1.Joi.string(),
97
+ });
98
+ const HtmlNavbarItemSchema = utils_validation_1.Joi.object({
99
+ className: utils_validation_1.Joi.string(),
100
+ type: utils_validation_1.Joi.string().equal('html').required(),
101
+ value: utils_validation_1.Joi.string().required(),
106
102
  });
107
-
108
- const HtmlNavbarItemSchema = _utilsValidation.Joi.object({
109
- className: _utilsValidation.Joi.string(),
110
- type: _utilsValidation.Joi.string().equal('html').required(),
111
- value: _utilsValidation.Joi.string().required()
112
- }); // A temporary workaround to allow users to add custom navbar items
103
+ // A temporary workaround to allow users to add custom navbar items
113
104
  // See https://github.com/facebook/docusaurus/issues/7227
114
-
115
-
116
105
  const CustomNavbarItemRegexp = /custom-.*/;
117
-
118
- const CustomNavbarItemSchema = _utilsValidation.Joi.object({
119
- type: _utilsValidation.Joi.string().regex(CustomNavbarItemRegexp).required()
106
+ const CustomNavbarItemSchema = utils_validation_1.Joi.object({
107
+ type: utils_validation_1.Joi.string().regex(CustomNavbarItemRegexp).required(),
120
108
  }).unknown();
121
-
122
- const itemWithType = type => {
123
- // Because equal(undefined) is not supported :/
124
- const typeSchema = // eslint-disable-next-line no-nested-ternary
125
- type instanceof RegExp ? _utilsValidation.Joi.string().required().regex(type) : type ? _utilsValidation.Joi.string().required().equal(type) : _utilsValidation.Joi.string().forbidden();
126
- return _utilsValidation.Joi.object({
127
- type: typeSchema
128
- }).unknown().required();
109
+ const itemWithType = (type) => {
110
+ // Because equal(undefined) is not supported :/
111
+ const typeSchema =
112
+ // eslint-disable-next-line no-nested-ternary
113
+ type instanceof RegExp
114
+ ? utils_validation_1.Joi.string().required().regex(type)
115
+ : type
116
+ ? utils_validation_1.Joi.string().required().equal(type)
117
+ : utils_validation_1.Joi.string().forbidden();
118
+ return utils_validation_1.Joi.object({
119
+ type: typeSchema,
120
+ })
121
+ .unknown()
122
+ .required();
129
123
  };
130
-
131
- const DropdownSubitemSchema = _utilsValidation.Joi.object({
132
- position: _utilsValidation.Joi.forbidden()
124
+ const DropdownSubitemSchema = utils_validation_1.Joi.object({
125
+ position: utils_validation_1.Joi.forbidden(),
133
126
  }).when('.', {
134
- switch: [{
135
- is: itemWithType('docsVersion'),
136
- then: DocsVersionNavbarItemSchema
137
- }, {
138
- is: itemWithType('doc'),
139
- then: DocItemSchema
140
- }, {
141
- is: itemWithType('docSidebar'),
142
- then: DocSidebarItemSchema
143
- }, {
144
- is: itemWithType(undefined),
145
- then: DefaultNavbarItemSchema
146
- }, {
147
- is: itemWithType('html'),
148
- then: HtmlNavbarItemSchema
149
- }, {
150
- is: itemWithType(CustomNavbarItemRegexp),
151
- then: CustomNavbarItemSchema
152
- }, {
153
- is: _utilsValidation.Joi.alternatives().try(itemWithType('dropdown'), itemWithType('docsVersionDropdown'), itemWithType('localeDropdown'), itemWithType('search')),
154
- then: _utilsValidation.Joi.forbidden().messages({
155
- 'any.unknown': 'Nested dropdowns are not allowed'
156
- })
157
- }],
158
- otherwise: _utilsValidation.Joi.forbidden().messages({
159
- 'any.unknown': 'Bad navbar item type {.type}'
160
- })
127
+ switch: [
128
+ {
129
+ is: itemWithType('docsVersion'),
130
+ then: DocsVersionNavbarItemSchema,
131
+ },
132
+ {
133
+ is: itemWithType('doc'),
134
+ then: DocItemSchema,
135
+ },
136
+ {
137
+ is: itemWithType('docSidebar'),
138
+ then: DocSidebarItemSchema,
139
+ },
140
+ {
141
+ is: itemWithType(undefined),
142
+ then: DefaultNavbarItemSchema,
143
+ },
144
+ {
145
+ is: itemWithType('html'),
146
+ then: HtmlNavbarItemSchema,
147
+ },
148
+ {
149
+ is: itemWithType(CustomNavbarItemRegexp),
150
+ then: CustomNavbarItemSchema,
151
+ },
152
+ {
153
+ is: utils_validation_1.Joi.alternatives().try(itemWithType('dropdown'), itemWithType('docsVersionDropdown'), itemWithType('localeDropdown'), itemWithType('search')),
154
+ then: utils_validation_1.Joi.forbidden().messages({
155
+ 'any.unknown': 'Nested dropdowns are not allowed',
156
+ }),
157
+ },
158
+ ],
159
+ otherwise: utils_validation_1.Joi.forbidden().messages({
160
+ 'any.unknown': 'Bad navbar item type {.type}',
161
+ }),
161
162
  });
162
-
163
163
  const DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
164
- items: _utilsValidation.Joi.array().items(DropdownSubitemSchema).required()
164
+ items: utils_validation_1.Joi.array().items(DropdownSubitemSchema).required(),
165
165
  });
166
166
  const DocsVersionDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
167
- type: _utilsValidation.Joi.string().equal('docsVersionDropdown').required(),
168
- docsPluginId: _utilsValidation.Joi.string(),
169
- dropdownActiveClassDisabled: _utilsValidation.Joi.boolean(),
170
- dropdownItemsBefore: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([]),
171
- dropdownItemsAfter: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([])
167
+ type: utils_validation_1.Joi.string().equal('docsVersionDropdown').required(),
168
+ docsPluginId: utils_validation_1.Joi.string(),
169
+ dropdownActiveClassDisabled: utils_validation_1.Joi.boolean(),
170
+ dropdownItemsBefore: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
171
+ dropdownItemsAfter: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
172
172
  });
173
173
  const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
174
- type: _utilsValidation.Joi.string().equal('localeDropdown').required(),
175
- dropdownItemsBefore: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([]),
176
- dropdownItemsAfter: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([])
174
+ type: utils_validation_1.Joi.string().equal('localeDropdown').required(),
175
+ dropdownItemsBefore: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
176
+ dropdownItemsAfter: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
177
177
  });
178
-
179
- const SearchItemSchema = _utilsValidation.Joi.object({
180
- type: _utilsValidation.Joi.string().equal('search').required()
178
+ const SearchItemSchema = utils_validation_1.Joi.object({
179
+ type: utils_validation_1.Joi.string().equal('search').required(),
181
180
  });
182
-
183
- const NavbarItemSchema = _utilsValidation.Joi.object({
184
- position: NavbarItemPosition
181
+ const NavbarItemSchema = utils_validation_1.Joi.object({
182
+ position: NavbarItemPosition,
185
183
  }).when('.', {
186
- switch: [{
187
- is: itemWithType('docsVersion'),
188
- then: DocsVersionNavbarItemSchema
189
- }, {
190
- is: itemWithType('dropdown'),
191
- then: DropdownNavbarItemSchema
192
- }, {
193
- is: itemWithType('docsVersionDropdown'),
194
- then: DocsVersionDropdownNavbarItemSchema
195
- }, {
196
- is: itemWithType('doc'),
197
- then: DocItemSchema
198
- }, {
199
- is: itemWithType('docSidebar'),
200
- then: DocSidebarItemSchema
201
- }, {
202
- is: itemWithType('localeDropdown'),
203
- then: LocaleDropdownNavbarItemSchema
204
- }, {
205
- is: itemWithType('search'),
206
- then: SearchItemSchema
207
- }, {
208
- is: itemWithType('html'),
209
- then: HtmlNavbarItemSchema
210
- }, {
211
- is: itemWithType(CustomNavbarItemRegexp),
212
- then: CustomNavbarItemSchema
213
- }, {
214
- is: itemWithType(undefined),
215
- then: _utilsValidation.Joi.object().when('.', {
216
- // Dropdown item can be specified without type field
217
- is: _utilsValidation.Joi.object({
218
- items: _utilsValidation.Joi.array().required()
219
- }).unknown(),
220
- then: DropdownNavbarItemSchema,
221
- otherwise: DefaultNavbarItemSchema
222
- })
223
- }],
224
- otherwise: _utilsValidation.Joi.forbidden().messages({
225
- 'any.unknown': 'Bad navbar item type {.type}'
226
- })
184
+ switch: [
185
+ {
186
+ is: itemWithType('docsVersion'),
187
+ then: DocsVersionNavbarItemSchema,
188
+ },
189
+ {
190
+ is: itemWithType('dropdown'),
191
+ then: DropdownNavbarItemSchema,
192
+ },
193
+ {
194
+ is: itemWithType('docsVersionDropdown'),
195
+ then: DocsVersionDropdownNavbarItemSchema,
196
+ },
197
+ {
198
+ is: itemWithType('doc'),
199
+ then: DocItemSchema,
200
+ },
201
+ {
202
+ is: itemWithType('docSidebar'),
203
+ then: DocSidebarItemSchema,
204
+ },
205
+ {
206
+ is: itemWithType('localeDropdown'),
207
+ then: LocaleDropdownNavbarItemSchema,
208
+ },
209
+ {
210
+ is: itemWithType('search'),
211
+ then: SearchItemSchema,
212
+ },
213
+ {
214
+ is: itemWithType('html'),
215
+ then: HtmlNavbarItemSchema,
216
+ },
217
+ {
218
+ is: itemWithType(CustomNavbarItemRegexp),
219
+ then: CustomNavbarItemSchema,
220
+ },
221
+ {
222
+ is: itemWithType(undefined),
223
+ then: utils_validation_1.Joi.object().when('.', {
224
+ // Dropdown item can be specified without type field
225
+ is: utils_validation_1.Joi.object({
226
+ items: utils_validation_1.Joi.array().required(),
227
+ }).unknown(),
228
+ then: DropdownNavbarItemSchema,
229
+ otherwise: DefaultNavbarItemSchema,
230
+ }),
231
+ },
232
+ ],
233
+ otherwise: utils_validation_1.Joi.forbidden().messages({
234
+ 'any.unknown': 'Bad navbar item type {.type}',
235
+ }),
227
236
  });
228
-
229
- const ColorModeSchema = _utilsValidation.Joi.object({
230
- defaultMode: _utilsValidation.Joi.string().equal('dark', 'light').default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
231
- disableSwitch: _utilsValidation.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
232
- respectPrefersColorScheme: _utilsValidation.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme),
233
- switchConfig: _utilsValidation.Joi.any().forbidden().messages({
234
- 'any.unknown': 'colorMode.switchConfig is deprecated. If you want to customize the icons for light and dark mode, swizzle IconLightMode, IconDarkMode, or ColorModeToggle instead.'
235
- })
237
+ const ColorModeSchema = utils_validation_1.Joi.object({
238
+ defaultMode: utils_validation_1.Joi.string()
239
+ .equal('dark', 'light')
240
+ .default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
241
+ disableSwitch: utils_validation_1.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
242
+ respectPrefersColorScheme: utils_validation_1.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme),
243
+ switchConfig: utils_validation_1.Joi.any().forbidden().messages({
244
+ 'any.unknown': 'colorMode.switchConfig is deprecated. If you want to customize the icons for light and dark mode, swizzle IconLightMode, IconDarkMode, or ColorModeToggle instead.',
245
+ }),
236
246
  }).default(DEFAULT_COLOR_MODE_CONFIG);
237
-
238
- const HtmlMetadataSchema = _utilsValidation.Joi.object({
239
- id: _utilsValidation.Joi.string(),
240
- name: _utilsValidation.Joi.string(),
241
- property: _utilsValidation.Joi.string(),
242
- content: _utilsValidation.Joi.string(),
243
- itemprop: _utilsValidation.Joi.string()
247
+ const HtmlMetadataSchema = utils_validation_1.Joi.object({
248
+ id: utils_validation_1.Joi.string(),
249
+ name: utils_validation_1.Joi.string(),
250
+ property: utils_validation_1.Joi.string(),
251
+ content: utils_validation_1.Joi.string(),
252
+ itemprop: utils_validation_1.Joi.string(),
244
253
  }).unknown();
245
-
246
- const FooterLinkItemSchema = _utilsValidation.Joi.object({
247
- to: _utilsValidation.Joi.string(),
248
- href: _utilsValidation.URISchema,
249
- html: _utilsValidation.Joi.string(),
250
- label: _utilsValidation.Joi.string()
251
- }).xor('to', 'href', 'html').with('to', 'label').with('href', 'label').nand('html', 'label') // We allow any unknown attributes on the links (users may need additional
252
- // attributes like target, aria-role, data-customAttribute...)
253
- .unknown();
254
-
255
- const CustomCssSchema = _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array().items(_utilsValidation.Joi.string().required()), _utilsValidation.Joi.string().required()).optional();
256
-
257
- const ThemeConfigSchema = _utilsValidation.Joi.object({
258
- // TODO temporary (@alpha-58)
259
- disableDarkMode: _utilsValidation.Joi.any().forbidden().messages({
260
- 'any.unknown': 'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true'
261
- }),
262
- // TODO temporary (@alpha-58)
263
- defaultDarkMode: _utilsValidation.Joi.any().forbidden().messages({
264
- 'any.unknown': 'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"'
265
- }),
266
- customCss: CustomCssSchema,
267
- colorMode: ColorModeSchema,
268
- image: _utilsValidation.Joi.string(),
269
- docs: DocsSchema,
270
- metadata: _utilsValidation.Joi.array().items(HtmlMetadataSchema).default(DEFAULT_CONFIG.metadata),
271
- // cSpell:ignore metadatas
272
- metadatas: _utilsValidation.Joi.any().forbidden().messages({
273
- 'any.unknown': // cSpell:ignore metadatas
274
- 'themeConfig.metadatas has been renamed as themeConfig.metadata. See https://github.com/facebook/docusaurus/pull/5871'
275
- }),
276
- announcementBar: _utilsValidation.Joi.object({
277
- id: _utilsValidation.Joi.string().default('announcement-bar'),
278
- content: _utilsValidation.Joi.string().required(),
279
- backgroundColor: _utilsValidation.Joi.string(),
280
- textColor: _utilsValidation.Joi.string(),
281
- isCloseable: _utilsValidation.Joi.bool().default(true)
282
- }).optional(),
283
- navbar: _utilsValidation.Joi.object({
284
- style: _utilsValidation.Joi.string().equal('dark', 'primary'),
285
- hideOnScroll: _utilsValidation.Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
254
+ const FooterLinkItemSchema = utils_validation_1.Joi.object({
255
+ to: utils_validation_1.Joi.string(),
256
+ href: utils_validation_1.URISchema,
257
+ html: utils_validation_1.Joi.string(),
258
+ label: utils_validation_1.Joi.string(),
259
+ })
260
+ .xor('to', 'href', 'html')
261
+ .with('to', 'label')
262
+ .with('href', 'label')
263
+ .nand('html', 'label')
264
+ // We allow any unknown attributes on the links (users may need additional
265
+ // attributes like target, aria-role, data-customAttribute...)
266
+ .unknown();
267
+ const CustomCssSchema = utils_validation_1.Joi.alternatives()
268
+ .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required()), utils_validation_1.Joi.string().required())
269
+ .optional();
270
+ exports.ThemeConfigSchema = utils_validation_1.Joi.object({
286
271
  // TODO temporary (@alpha-58)
287
- links: _utilsValidation.Joi.any().forbidden().messages({
288
- 'any.unknown': 'themeConfig.navbar.links has been renamed as themeConfig.navbar.items'
272
+ disableDarkMode: utils_validation_1.Joi.any().forbidden().messages({
273
+ 'any.unknown': 'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
289
274
  }),
290
- items: _utilsValidation.Joi.array().items(NavbarItemSchema).default(DEFAULT_CONFIG.navbar.items),
291
- title: _utilsValidation.Joi.string().allow('', null),
292
- logo: _utilsValidation.Joi.object({
293
- alt: _utilsValidation.Joi.string().allow(''),
294
- src: _utilsValidation.Joi.string().required(),
295
- srcDark: _utilsValidation.Joi.string(),
296
- width: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
297
- height: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
298
- href: _utilsValidation.Joi.string(),
299
- target: _utilsValidation.Joi.string()
275
+ // TODO temporary (@alpha-58)
276
+ defaultDarkMode: utils_validation_1.Joi.any().forbidden().messages({
277
+ 'any.unknown': 'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
278
+ }),
279
+ customCss: CustomCssSchema,
280
+ colorMode: ColorModeSchema,
281
+ image: utils_validation_1.Joi.string(),
282
+ docs: DocsSchema,
283
+ metadata: utils_validation_1.Joi.array()
284
+ .items(HtmlMetadataSchema)
285
+ .default(exports.DEFAULT_CONFIG.metadata),
286
+ // cSpell:ignore metadatas
287
+ metadatas: utils_validation_1.Joi.any().forbidden().messages({
288
+ 'any.unknown':
289
+ // cSpell:ignore metadatas
290
+ 'themeConfig.metadatas has been renamed as themeConfig.metadata. See https://github.com/facebook/docusaurus/pull/5871',
291
+ }),
292
+ announcementBar: utils_validation_1.Joi.object({
293
+ id: utils_validation_1.Joi.string().default('announcement-bar'),
294
+ content: utils_validation_1.Joi.string().required(),
295
+ backgroundColor: utils_validation_1.Joi.string(),
296
+ textColor: utils_validation_1.Joi.string(),
297
+ isCloseable: utils_validation_1.Joi.bool().default(true),
298
+ }).optional(),
299
+ navbar: utils_validation_1.Joi.object({
300
+ style: utils_validation_1.Joi.string().equal('dark', 'primary'),
301
+ hideOnScroll: utils_validation_1.Joi.bool().default(exports.DEFAULT_CONFIG.navbar.hideOnScroll),
302
+ // TODO temporary (@alpha-58)
303
+ links: utils_validation_1.Joi.any().forbidden().messages({
304
+ 'any.unknown': 'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
305
+ }),
306
+ items: utils_validation_1.Joi.array()
307
+ .items(NavbarItemSchema)
308
+ .default(exports.DEFAULT_CONFIG.navbar.items),
309
+ title: utils_validation_1.Joi.string().allow('', null),
310
+ logo: utils_validation_1.Joi.object({
311
+ alt: utils_validation_1.Joi.string().allow(''),
312
+ src: utils_validation_1.Joi.string().required(),
313
+ srcDark: utils_validation_1.Joi.string(),
314
+ width: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
315
+ height: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
316
+ href: utils_validation_1.Joi.string(),
317
+ target: utils_validation_1.Joi.string(),
318
+ }),
319
+ }).default(exports.DEFAULT_CONFIG.navbar),
320
+ footer: utils_validation_1.Joi.object({
321
+ style: utils_validation_1.Joi.string().equal('dark', 'light').default('light'),
322
+ logo: utils_validation_1.Joi.object({
323
+ alt: utils_validation_1.Joi.string().allow(''),
324
+ src: utils_validation_1.Joi.string().required(),
325
+ srcDark: utils_validation_1.Joi.string(),
326
+ // TODO infer this from reading the image
327
+ width: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
328
+ height: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
329
+ href: utils_validation_1.Joi.string(),
330
+ }),
331
+ copyright: utils_validation_1.Joi.string(),
332
+ links: utils_validation_1.Joi.alternatives(utils_validation_1.Joi.array().items(utils_validation_1.Joi.object({
333
+ title: utils_validation_1.Joi.string().allow(null).default(null),
334
+ items: utils_validation_1.Joi.array().items(FooterLinkItemSchema).default([]),
335
+ })), utils_validation_1.Joi.array().items(FooterLinkItemSchema))
336
+ .messages({
337
+ 'alternatives.match': `The footer must be either simple or multi-column, and not a mix of the two. See: https://docusaurus.io/docs/api/themes/configuration#footer-links`,
338
+ })
339
+ .default([]),
340
+ }).optional(),
341
+ prism: utils_validation_1.Joi.object({
342
+ theme: utils_validation_1.Joi.object({
343
+ plain: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
344
+ styles: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
345
+ }).default(exports.DEFAULT_CONFIG.prism.theme),
346
+ darkTheme: utils_validation_1.Joi.object({
347
+ plain: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
348
+ styles: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
349
+ }),
350
+ defaultLanguage: utils_validation_1.Joi.string(),
351
+ additionalLanguages: utils_validation_1.Joi.array()
352
+ .items(utils_validation_1.Joi.string())
353
+ .default(exports.DEFAULT_CONFIG.prism.additionalLanguages),
354
+ magicComments: utils_validation_1.Joi.array()
355
+ .items(utils_validation_1.Joi.object({
356
+ className: utils_validation_1.Joi.string().required(),
357
+ line: utils_validation_1.Joi.string(),
358
+ block: utils_validation_1.Joi.object({
359
+ start: utils_validation_1.Joi.string().required(),
360
+ end: utils_validation_1.Joi.string().required(),
361
+ }),
362
+ }).or('line', 'block'))
363
+ .default(exports.DEFAULT_CONFIG.prism.magicComments),
300
364
  })
301
- }).default(DEFAULT_CONFIG.navbar),
302
- footer: _utilsValidation.Joi.object({
303
- style: _utilsValidation.Joi.string().equal('dark', 'light').default('light'),
304
- logo: _utilsValidation.Joi.object({
305
- alt: _utilsValidation.Joi.string().allow(''),
306
- src: _utilsValidation.Joi.string().required(),
307
- srcDark: _utilsValidation.Joi.string(),
308
- // TODO infer this from reading the image
309
- width: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
310
- height: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
311
- href: _utilsValidation.Joi.string()
365
+ .default(exports.DEFAULT_CONFIG.prism)
366
+ .unknown(),
367
+ hideableSidebar: utils_validation_1.Joi.forbidden().messages({
368
+ 'any.unknown': 'themeConfig.hideableSidebar has been moved to themeConfig.docs.sidebar.hideable.',
312
369
  }),
313
- copyright: _utilsValidation.Joi.string(),
314
- links: _utilsValidation.Joi.alternatives(_utilsValidation.Joi.array().items(_utilsValidation.Joi.object({
315
- title: _utilsValidation.Joi.string().allow(null).default(null),
316
- items: _utilsValidation.Joi.array().items(FooterLinkItemSchema).default([])
317
- })), _utilsValidation.Joi.array().items(FooterLinkItemSchema)).messages({
318
- 'alternatives.match': `The footer must be either simple or multi-column, and not a mix of the two. See: https://docusaurus.io/docs/api/themes/configuration#footer-links`
319
- }).default([])
320
- }).optional(),
321
- prism: _utilsValidation.Joi.object({
322
- theme: _utilsValidation.Joi.object({
323
- plain: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required(),
324
- styles: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required()
325
- }).default(DEFAULT_CONFIG.prism.theme),
326
- darkTheme: _utilsValidation.Joi.object({
327
- plain: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required(),
328
- styles: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required()
370
+ autoCollapseSidebarCategories: utils_validation_1.Joi.forbidden().messages({
371
+ 'any.unknown': 'themeConfig.autoCollapseSidebarCategories has been moved to themeConfig.docs.sidebar.autoCollapseCategories.',
329
372
  }),
330
- defaultLanguage: _utilsValidation.Joi.string(),
331
- additionalLanguages: _utilsValidation.Joi.array().items(_utilsValidation.Joi.string()).default(DEFAULT_CONFIG.prism.additionalLanguages),
332
- magicComments: _utilsValidation.Joi.array().items(_utilsValidation.Joi.object({
333
- className: _utilsValidation.Joi.string().required(),
334
- line: _utilsValidation.Joi.string(),
335
- block: _utilsValidation.Joi.object({
336
- start: _utilsValidation.Joi.string().required(),
337
- end: _utilsValidation.Joi.string().required()
338
- })
339
- }).or('line', 'block')).default(DEFAULT_CONFIG.prism.magicComments)
340
- }).default(DEFAULT_CONFIG.prism).unknown(),
341
- hideableSidebar: _utilsValidation.Joi.forbidden().messages({
342
- 'any.unknown': 'themeConfig.hideableSidebar has been moved to themeConfig.docs.sidebar.hideable.'
343
- }),
344
- autoCollapseSidebarCategories: _utilsValidation.Joi.forbidden().messages({
345
- 'any.unknown': 'themeConfig.autoCollapseSidebarCategories has been moved to themeConfig.docs.sidebar.autoCollapseCategories.'
346
- }),
347
- sidebarCollapsible: _utilsValidation.Joi.forbidden().messages({
348
- 'any.unknown': 'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs'
349
- }),
350
- tableOfContents: _utilsValidation.Joi.object({
351
- minHeadingLevel: _utilsValidation.Joi.number().default(DEFAULT_CONFIG.tableOfContents.minHeadingLevel).when('maxHeadingLevel', {
352
- is: _utilsValidation.Joi.exist(),
353
- then: _utilsValidation.Joi.number().integer().min(2).max(6).max(_utilsValidation.Joi.ref('maxHeadingLevel')),
354
- otherwise: _utilsValidation.Joi.number().integer().min(2).max(6)
373
+ sidebarCollapsible: utils_validation_1.Joi.forbidden().messages({
374
+ 'any.unknown': 'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs',
355
375
  }),
356
- maxHeadingLevel: _utilsValidation.Joi.number().integer().min(2).max(6).default(DEFAULT_CONFIG.tableOfContents.maxHeadingLevel)
357
- }).default(DEFAULT_CONFIG.tableOfContents)
376
+ tableOfContents: utils_validation_1.Joi.object({
377
+ minHeadingLevel: utils_validation_1.Joi.number()
378
+ .default(exports.DEFAULT_CONFIG.tableOfContents.minHeadingLevel)
379
+ .when('maxHeadingLevel', {
380
+ is: utils_validation_1.Joi.exist(),
381
+ then: utils_validation_1.Joi.number()
382
+ .integer()
383
+ .min(2)
384
+ .max(6)
385
+ .max(utils_validation_1.Joi.ref('maxHeadingLevel')),
386
+ otherwise: utils_validation_1.Joi.number().integer().min(2).max(6),
387
+ }),
388
+ maxHeadingLevel: utils_validation_1.Joi.number()
389
+ .integer()
390
+ .min(2)
391
+ .max(6)
392
+ .default(exports.DEFAULT_CONFIG.tableOfContents.maxHeadingLevel),
393
+ }).default(exports.DEFAULT_CONFIG.tableOfContents),
358
394
  });
359
-
360
- exports.ThemeConfigSchema = ThemeConfigSchema;
361
-
362
- function validateThemeConfig({
363
- validate,
364
- themeConfig
365
- }) {
366
- return validate(ThemeConfigSchema, themeConfig);
367
- }
395
+ function validateThemeConfig({ validate, themeConfig, }) {
396
+ return validate(exports.ThemeConfigSchema, themeConfig);
397
+ }
398
+ exports.validateThemeConfig = validateThemeConfig;