@docusaurus/theme-classic 2.0.0-beta.2 → 2.0.0-beta.22

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 (743) hide show
  1. package/README.md +2 -2
  2. package/lib/getSwizzleConfig.d.ts +8 -0
  3. package/lib/getSwizzleConfig.js +228 -0
  4. package/lib/index.d.ts +12 -0
  5. package/lib/index.js +108 -170
  6. package/lib/nprogress.css +41 -0
  7. package/lib/nprogress.d.ts +10 -0
  8. package/lib/nprogress.js +25 -0
  9. package/lib/prism-include-languages.d.ts +7 -0
  10. package/lib/prism-include-languages.js +0 -2
  11. package/lib/theme/Admonition/index.d.ts +9 -0
  12. package/lib/theme/Admonition/index.js +183 -0
  13. package/lib/theme/Admonition/styles.module.css +38 -0
  14. package/lib/theme/AnnouncementBar/index.d.ts +8 -0
  15. package/lib/theme/AnnouncementBar/index.js +39 -63
  16. package/lib/theme/AnnouncementBar/styles.module.css +23 -32
  17. package/lib/theme/BackToTopButton/index.d.ts +8 -0
  18. package/lib/theme/BackToTopButton/index.js +32 -0
  19. package/lib/theme/BackToTopButton/styles.module.css +44 -0
  20. package/lib/theme/BlogArchivePage/index.d.ts +10 -0
  21. package/lib/theme/BlogArchivePage/index.js +80 -0
  22. package/lib/theme/BlogLayout/index.d.ts +9 -0
  23. package/lib/theme/BlogLayout/index.js +33 -0
  24. package/lib/theme/BlogListPage/index.d.ts +10 -0
  25. package/lib/theme/BlogListPage/index.js +44 -61
  26. package/lib/theme/BlogListPaginator/index.d.ts +9 -0
  27. package/lib/theme/BlogListPaginator/index.js +41 -56
  28. package/lib/theme/BlogPostItem/Container/index.d.ts +9 -0
  29. package/lib/theme/BlogPostItem/Container/index.js +26 -0
  30. package/{lib-next/theme/Heading/styles.module.css → lib/theme/BlogPostItem/Content/index.d.ts} +3 -9
  31. package/lib/theme/BlogPostItem/Content/index.js +23 -0
  32. package/lib/theme/BlogPostItem/Footer/ReadMoreLink/index.d.ts +9 -0
  33. package/lib/theme/BlogPostItem/Footer/ReadMoreLink/index.js +38 -0
  34. package/lib/theme/BlogPostItem/Footer/index.d.ts +8 -0
  35. package/lib/theme/BlogPostItem/Footer/index.js +52 -0
  36. package/{src/theme/IconEdit → lib/theme/BlogPostItem/Footer}/styles.module.css +2 -3
  37. package/lib/theme/BlogPostItem/Header/Author/index.d.ts +9 -0
  38. package/lib/theme/BlogPostItem/Header/Author/index.js +47 -0
  39. package/lib/theme/BlogPostItem/Header/Authors/index.d.ts +9 -0
  40. package/lib/theme/BlogPostItem/Header/Authors/index.js +48 -0
  41. package/{lib-next/theme/Toggle → lib/theme/BlogPostItem/Header/Authors}/styles.module.css +11 -7
  42. package/lib/theme/BlogPostItem/Header/Info/index.d.ts +9 -0
  43. package/lib/theme/BlogPostItem/Header/Info/index.js +60 -0
  44. package/{lib-next/theme/MDXPage → lib/theme/BlogPostItem/Header/Info}/styles.module.css +2 -2
  45. package/lib/theme/BlogPostItem/Header/Title/index.d.ts +9 -0
  46. package/lib/theme/BlogPostItem/Header/Title/index.js +27 -0
  47. package/{src/theme/BlogPostItem → lib/theme/BlogPostItem/Header/Title}/styles.module.css +8 -7
  48. package/lib/theme/BlogPostItem/Header/index.d.ts +8 -0
  49. package/lib/theme/BlogPostItem/Header/index.js +19 -0
  50. package/lib/theme/BlogPostItem/index.d.ts +9 -0
  51. package/lib/theme/BlogPostItem/index.js +20 -153
  52. package/lib/theme/BlogPostItems/index.d.ts +9 -0
  53. package/lib/theme/BlogPostItems/index.js +27 -0
  54. package/lib/theme/BlogPostPage/Metadata/index.d.ts +8 -0
  55. package/lib/theme/BlogPostPage/Metadata/index.js +41 -0
  56. package/lib/theme/BlogPostPage/index.d.ts +10 -0
  57. package/lib/theme/BlogPostPage/index.js +51 -60
  58. package/lib/theme/BlogPostPaginator/index.d.ts +9 -0
  59. package/lib/theme/BlogPostPaginator/index.js +40 -57
  60. package/lib/theme/BlogSidebar/Desktop/index.d.ts +9 -0
  61. package/{lib-next/theme/BlogSidebar → lib/theme/BlogSidebar/Desktop}/index.js +19 -23
  62. package/{lib-next/theme/BlogSidebar → lib/theme/BlogSidebar/Desktop}/styles.module.css +5 -4
  63. package/lib/theme/BlogSidebar/Mobile/index.d.ts +9 -0
  64. package/lib/theme/BlogSidebar/Mobile/index.js +34 -0
  65. package/lib/theme/BlogSidebar/index.d.ts +9 -0
  66. package/lib/theme/BlogSidebar/index.js +13 -43
  67. package/lib/theme/BlogTagsListPage/index.d.ts +10 -0
  68. package/lib/theme/BlogTagsListPage/index.js +27 -69
  69. package/lib/theme/BlogTagsPostsPage/index.d.ts +10 -0
  70. package/lib/theme/BlogTagsPostsPage/index.js +78 -89
  71. package/lib/theme/CodeBlock/Container/index.d.ts +10 -0
  72. package/lib/theme/CodeBlock/Container/index.js +27 -0
  73. package/lib/theme/CodeBlock/Container/styles.module.css +14 -0
  74. package/lib/theme/CodeBlock/Content/Element.d.ts +9 -0
  75. package/lib/theme/CodeBlock/Content/Element.js +23 -0
  76. package/lib/theme/CodeBlock/Content/String.d.ts +9 -0
  77. package/lib/theme/CodeBlock/Content/String.js +103 -0
  78. package/{lib-next/theme/CodeBlock → lib/theme/CodeBlock/Content}/styles.module.css +45 -27
  79. package/lib/theme/CodeBlock/CopyButton/index.d.ts +9 -0
  80. package/lib/theme/CodeBlock/CopyButton/index.js +62 -0
  81. package/lib/theme/CodeBlock/CopyButton/styles.module.css +47 -0
  82. package/lib/theme/CodeBlock/Line/index.d.ts +9 -0
  83. package/lib/theme/CodeBlock/Line/index.js +42 -0
  84. package/lib/theme/CodeBlock/Line/styles.module.css +51 -0
  85. package/lib/theme/CodeBlock/WordWrapButton/index.d.ts +9 -0
  86. package/lib/theme/CodeBlock/WordWrapButton/index.js +40 -0
  87. package/lib/theme/{BlogPostItem → CodeBlock/WordWrapButton}/styles.module.css +5 -8
  88. package/lib/theme/CodeBlock/index.d.ts +9 -0
  89. package/lib/theme/CodeBlock/index.js +31 -246
  90. package/lib/theme/ColorModeToggle/index.d.ts +11 -0
  91. package/lib/theme/ColorModeToggle/index.js +60 -0
  92. package/lib/theme/ColorModeToggle/styles.module.css +35 -0
  93. package/lib/theme/Details/index.d.ts +9 -0
  94. package/lib/theme/Details/index.js +21 -0
  95. package/lib/theme/Details/styles.module.css +13 -0
  96. package/lib/theme/DocBreadcrumbs/index.d.ts +8 -0
  97. package/lib/theme/DocBreadcrumbs/index.js +115 -0
  98. package/{lib-next/theme/Heading/styles.css → lib/theme/DocBreadcrumbs/styles.module.css} +9 -13
  99. package/lib/theme/DocCard/index.d.ts +9 -0
  100. package/lib/theme/DocCard/index.js +86 -0
  101. package/lib/theme/DocCard/styles.module.css +34 -0
  102. package/lib/theme/DocCardList/index.d.ts +9 -0
  103. package/lib/theme/DocCardList/index.js +30 -0
  104. package/lib/theme/DocCategoryGeneratedIndexPage/index.d.ts +10 -0
  105. package/lib/theme/DocCategoryGeneratedIndexPage/index.js +74 -0
  106. package/lib/theme/DocCategoryGeneratedIndexPage/styles.module.css +26 -0
  107. package/lib/theme/DocItem/Content/index.d.ts +9 -0
  108. package/lib/theme/DocItem/Content/index.js +44 -0
  109. package/lib/theme/DocItem/Footer/index.d.ts +8 -0
  110. package/lib/theme/DocItem/Footer/index.js +74 -0
  111. package/lib/theme/DocItem/{styles.module.css → Footer/styles.module.css} +1 -9
  112. package/lib/theme/DocItem/Layout/index.d.ts +9 -0
  113. package/lib/theme/DocItem/Layout/index.js +59 -0
  114. package/{src/theme/DocItem → lib/theme/DocItem/Layout}/styles.module.css +3 -12
  115. package/lib/theme/DocItem/Metadata/index.d.ts +8 -0
  116. package/lib/theme/DocItem/Metadata/index.js +20 -0
  117. package/lib/theme/DocItem/Paginator/index.d.ts +12 -0
  118. package/lib/theme/DocItem/Paginator/index.js +17 -0
  119. package/lib/theme/DocItem/TOC/Desktop/index.d.ts +8 -0
  120. package/lib/theme/DocItem/TOC/Desktop/index.js +21 -0
  121. package/lib/theme/DocItem/TOC/Mobile/index.d.ts +8 -0
  122. package/lib/theme/DocItem/TOC/Mobile/index.js +23 -0
  123. package/lib/theme/DocItem/TOC/Mobile/styles.module.css +19 -0
  124. package/lib/theme/DocItem/index.d.ts +10 -0
  125. package/lib/theme/DocItem/index.js +18 -122
  126. package/lib/theme/DocPage/Layout/Main/index.d.ts +9 -0
  127. package/lib/theme/DocPage/Layout/Main/index.js +29 -0
  128. package/lib/theme/DocPage/Layout/Main/styles.module.css +28 -0
  129. package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/index.d.ts +9 -0
  130. package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/index.js +34 -0
  131. package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/styles.module.css +33 -0
  132. package/lib/theme/DocPage/Layout/Sidebar/index.d.ts +9 -0
  133. package/lib/theme/DocPage/Layout/Sidebar/index.js +66 -0
  134. package/lib/theme/DocPage/Layout/Sidebar/styles.module.css +32 -0
  135. package/lib/theme/DocPage/Layout/index.d.ts +9 -0
  136. package/lib/theme/DocPage/Layout/index.js +34 -0
  137. package/{lib-next/theme/IconExternalLink → lib/theme/DocPage/Layout}/styles.module.css +7 -4
  138. package/lib/theme/DocPage/index.d.ts +10 -0
  139. package/lib/theme/DocPage/index.js +42 -165
  140. package/lib/theme/DocPaginator/index.d.ts +9 -0
  141. package/lib/theme/DocPaginator/index.js +40 -56
  142. package/lib/theme/DocSidebar/Desktop/CollapseButton/index.d.ts +9 -0
  143. package/lib/theme/DocSidebar/Desktop/CollapseButton/index.js +34 -0
  144. package/lib/theme/DocSidebar/Desktop/CollapseButton/styles.module.css +46 -0
  145. package/lib/theme/DocSidebar/Desktop/Content/index.d.ts +9 -0
  146. package/lib/theme/DocSidebar/Desktop/Content/index.js +44 -0
  147. package/lib/theme/DocSidebar/Desktop/Content/styles.module.css +23 -0
  148. package/lib/theme/DocSidebar/Desktop/index.d.ts +11 -0
  149. package/lib/theme/DocSidebar/Desktop/index.js +34 -0
  150. package/lib/theme/DocSidebar/Desktop/styles.module.css +50 -0
  151. package/lib/theme/DocSidebar/Mobile/index.d.ts +11 -0
  152. package/lib/theme/DocSidebar/Mobile/index.js +45 -0
  153. package/lib/theme/DocSidebar/index.d.ts +9 -0
  154. package/lib/theme/DocSidebar/index.js +17 -299
  155. package/lib/theme/DocSidebarItem/Category/index.d.ts +9 -0
  156. package/lib/theme/DocSidebarItem/Category/index.js +185 -0
  157. package/lib/theme/DocSidebarItem/Html/index.d.ts +9 -0
  158. package/lib/theme/DocSidebarItem/Html/index.js +26 -0
  159. package/lib/theme/DocSidebarItem/Html/styles.module.css +13 -0
  160. package/lib/theme/DocSidebarItem/Link/index.d.ts +9 -0
  161. package/lib/theme/DocSidebarItem/Link/index.js +54 -0
  162. package/lib/theme/DocSidebarItem/Link/styles.module.css +10 -0
  163. package/lib/theme/DocSidebarItem/index.d.ts +9 -0
  164. package/lib/theme/DocSidebarItem/index.js +21 -0
  165. package/lib/theme/DocSidebarItems/index.d.ts +11 -0
  166. package/lib/theme/DocSidebarItems/index.js +22 -0
  167. package/lib/theme/DocTagDocListPage/index.d.ts +10 -0
  168. package/lib/theme/DocTagDocListPage/index.js +89 -0
  169. package/lib/theme/DocTagsListPage/index.d.ts +10 -0
  170. package/lib/theme/DocTagsListPage/index.js +40 -0
  171. package/lib/theme/DocVersionBadge/index.d.ts +9 -0
  172. package/lib/theme/DocVersionBadge/index.js +31 -0
  173. package/lib/theme/DocVersionBanner/index.d.ts +9 -0
  174. package/lib/theme/DocVersionBanner/index.js +105 -102
  175. package/lib/theme/EditThisPage/index.d.ts +9 -0
  176. package/lib/theme/EditThisPage/index.js +19 -24
  177. package/{src/theme/hooks/useLockBodyScroll.ts → lib/theme/ErrorPageContent.d.ts} +4 -14
  178. package/lib/theme/ErrorPageContent.js +35 -0
  179. package/lib/theme/Footer/Copyright/index.d.ts +9 -0
  180. package/lib/theme/Footer/Copyright/index.js +17 -0
  181. package/lib/theme/Footer/Layout/index.d.ts +9 -0
  182. package/lib/theme/Footer/Layout/index.js +26 -0
  183. package/lib/theme/Footer/LinkItem/index.d.ts +9 -0
  184. package/lib/theme/Footer/LinkItem/index.js +31 -0
  185. package/lib/theme/Footer/Links/MultiColumn/index.d.ts +9 -0
  186. package/lib/theme/Footer/Links/MultiColumn/index.js +43 -0
  187. package/lib/theme/Footer/Links/Simple/index.d.ts +9 -0
  188. package/lib/theme/Footer/Links/Simple/index.js +37 -0
  189. package/lib/theme/Footer/Links/index.d.ts +9 -0
  190. package/lib/theme/Footer/Links/index.js +17 -0
  191. package/lib/theme/Footer/Logo/index.d.ts +9 -0
  192. package/lib/theme/Footer/Logo/index.js +41 -0
  193. package/{src/theme/Footer → lib/theme/Footer/Logo}/styles.module.css +2 -1
  194. package/{lib-next/theme/Footer/styles.module.css → lib/theme/Footer/index.d.ts} +4 -9
  195. package/lib/theme/Footer/index.js +17 -97
  196. package/lib/theme/Heading/index.d.ts +9 -0
  197. package/lib/theme/Heading/index.js +35 -68
  198. package/lib/theme/Heading/styles.module.css +25 -5
  199. package/lib/theme/Icon/Arrow/index.d.ts +9 -0
  200. package/{lib-next/theme/IconArrow → lib/theme/Icon/Arrow}/index.js +2 -5
  201. package/lib/theme/Icon/Close/index.d.ts +9 -0
  202. package/lib/theme/Icon/Close/index.js +23 -0
  203. package/lib/theme/Icon/DarkMode/index.d.ts +9 -0
  204. package/lib/theme/Icon/DarkMode/index.js +17 -0
  205. package/lib/theme/Icon/Edit/index.d.ts +9 -0
  206. package/{lib-next/theme/IconEdit → lib/theme/Icon/Edit}/index.js +2 -5
  207. package/{lib-next/theme/IconEdit → lib/theme/Icon/Edit}/styles.module.css +0 -0
  208. package/lib/theme/Icon/ExternalLink/index.d.ts +9 -0
  209. package/{lib-next/theme/IconExternalLink → lib/theme/Icon/ExternalLink}/index.js +2 -5
  210. package/lib/theme/{IconExternalLink → Icon/ExternalLink}/styles.module.css +0 -2
  211. package/lib/theme/Icon/Home/index.d.ts +9 -0
  212. package/lib/theme/Icon/Home/index.js +17 -0
  213. package/lib/theme/Icon/Language/index.d.ts +9 -0
  214. package/lib/theme/Icon/Language/index.js +22 -0
  215. package/lib/theme/Icon/LightMode/index.d.ts +9 -0
  216. package/lib/theme/Icon/LightMode/index.js +17 -0
  217. package/lib/theme/Icon/Menu/index.d.ts +9 -0
  218. package/{lib-next/theme/IconMenu → lib/theme/Icon/Menu}/index.js +7 -5
  219. package/lib/theme/LastUpdated/index.d.ts +9 -0
  220. package/lib/theme/LastUpdated/index.js +57 -42
  221. package/lib/theme/Layout/Provider/index.d.ts +9 -0
  222. package/lib/theme/Layout/Provider/index.js +29 -0
  223. package/lib/theme/Layout/index.d.ts +9 -0
  224. package/lib/theme/Layout/index.js +39 -50
  225. package/lib/theme/Layout/{styles.css → styles.module.css} +10 -12
  226. package/lib/theme/Logo/index.d.ts +9 -0
  227. package/lib/theme/Logo/index.js +57 -51
  228. package/lib/theme/MDXComponents/A.d.ts +9 -0
  229. package/{lib-next/theme/ThemeContext.js → lib/theme/MDXComponents/A.js} +4 -2
  230. package/lib/theme/MDXComponents/Code.d.ts +9 -0
  231. package/lib/theme/MDXComponents/Code.js +28 -0
  232. package/lib/theme/MDXComponents/Details.d.ts +9 -0
  233. package/lib/theme/MDXComponents/Details.js +22 -0
  234. package/lib/theme/MDXComponents/Head.d.ts +9 -0
  235. package/lib/theme/MDXComponents/Head.js +23 -0
  236. package/lib/theme/MDXComponents/Heading.d.ts +9 -0
  237. package/{lib-next/theme/NavbarItem/SearchNavbarItem.js → lib/theme/MDXComponents/Heading.js} +3 -7
  238. package/lib/theme/MDXComponents/Img/index.d.ts +9 -0
  239. package/lib/theme/MDXComponents/Img/index.js +22 -0
  240. package/lib/theme/MDXComponents/Img/styles.module.css +10 -0
  241. package/lib/theme/MDXComponents/Pre.d.ts +9 -0
  242. package/lib/theme/MDXComponents/Pre.js +19 -0
  243. package/lib/theme/MDXComponents/Ul/index.d.ts +9 -0
  244. package/lib/theme/MDXComponents/Ul/index.js +21 -0
  245. package/lib/theme/MDXComponents/Ul/styles.module.css +14 -0
  246. package/lib/theme/MDXComponents/index.d.ts +9 -0
  247. package/lib/theme/MDXComponents/index.js +25 -57
  248. package/lib/theme/MDXContent/index.d.ts +9 -0
  249. package/lib/theme/MDXContent/index.js +12 -0
  250. package/lib/theme/MDXPage/index.d.ts +10 -0
  251. package/lib/theme/MDXPage/index.js +46 -56
  252. package/lib/theme/Navbar/ColorModeToggle/index.d.ts +9 -0
  253. package/lib/theme/Navbar/ColorModeToggle/index.js +23 -0
  254. package/lib/theme/Navbar/Content/index.d.ts +8 -0
  255. package/lib/theme/Navbar/Content/index.js +71 -0
  256. package/lib/theme/Navbar/Content/styles.module.css +15 -0
  257. package/lib/theme/Navbar/Layout/index.d.ts +9 -0
  258. package/lib/theme/Navbar/Layout/index.js +52 -0
  259. package/{lib-next/theme/Navbar → lib/theme/Navbar/Layout}/styles.module.css +0 -6
  260. package/lib/theme/Navbar/Logo/index.d.ts +8 -0
  261. package/{lib-next/theme/TabItem → lib/theme/Navbar/Logo}/index.js +7 -12
  262. package/lib/theme/Navbar/MobileSidebar/Header/index.d.ts +8 -0
  263. package/lib/theme/Navbar/MobileSidebar/Header/index.js +31 -0
  264. package/lib/theme/Navbar/MobileSidebar/Layout/index.d.ts +9 -0
  265. package/lib/theme/Navbar/MobileSidebar/Layout/index.js +28 -0
  266. package/{lib-next/theme/TOCInline/styles.module.css → lib/theme/Navbar/MobileSidebar/PrimaryMenu/index.d.ts} +2 -6
  267. package/lib/theme/Navbar/MobileSidebar/PrimaryMenu/index.js +33 -0
  268. package/lib/theme/Navbar/MobileSidebar/SecondaryMenu/index.d.ts +8 -0
  269. package/lib/theme/Navbar/MobileSidebar/SecondaryMenu/index.js +36 -0
  270. package/lib/theme/Navbar/MobileSidebar/Toggle/index.d.ts +8 -0
  271. package/lib/theme/Navbar/MobileSidebar/Toggle/index.js +23 -0
  272. package/lib/theme/Navbar/MobileSidebar/index.d.ts +8 -0
  273. package/lib/theme/Navbar/MobileSidebar/index.js +29 -0
  274. package/lib/theme/Navbar/Search/index.d.ts +9 -0
  275. package/lib/theme/Navbar/Search/index.js +12 -0
  276. package/lib/theme/Navbar/Search/styles.module.css +20 -0
  277. package/{lib-next/theme/hooks/styles.css → lib/theme/Navbar/index.d.ts} +2 -4
  278. package/lib/theme/Navbar/index.js +9 -140
  279. package/lib/theme/NavbarItem/ComponentTypes.d.ts +9 -0
  280. package/lib/theme/NavbarItem/ComponentTypes.js +27 -0
  281. package/lib/theme/NavbarItem/DefaultNavbarItem.d.ts +10 -0
  282. package/lib/theme/NavbarItem/DefaultNavbarItem.js +36 -193
  283. package/lib/theme/NavbarItem/DocNavbarItem.d.ts +9 -0
  284. package/lib/theme/NavbarItem/DocNavbarItem.js +24 -52
  285. package/lib/theme/NavbarItem/DocSidebarNavbarItem.d.ts +9 -0
  286. package/lib/theme/NavbarItem/DocSidebarNavbarItem.js +33 -0
  287. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.d.ts +9 -0
  288. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +73 -62
  289. package/lib/theme/NavbarItem/DocsVersionNavbarItem.d.ts +9 -0
  290. package/lib/theme/NavbarItem/DocsVersionNavbarItem.js +11 -32
  291. package/lib/theme/NavbarItem/DropdownNavbarItem.d.ts +9 -0
  292. package/lib/theme/NavbarItem/DropdownNavbarItem.js +161 -0
  293. package/lib/theme/NavbarItem/HtmlNavbarItem.d.ts +9 -0
  294. package/lib/theme/NavbarItem/HtmlNavbarItem.js +28 -0
  295. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/index.d.ts +9 -0
  296. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/index.js +68 -0
  297. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  298. package/lib/theme/NavbarItem/NavbarNavLink.d.ts +9 -0
  299. package/lib/theme/NavbarItem/NavbarNavLink.js +68 -0
  300. package/lib/theme/NavbarItem/SearchNavbarItem.d.ts +9 -0
  301. package/lib/theme/NavbarItem/SearchNavbarItem.js +10 -19
  302. package/lib/theme/NavbarItem/index.d.ts +9 -0
  303. package/lib/theme/NavbarItem/index.js +15 -45
  304. package/lib/theme/NotFound.d.ts +8 -0
  305. package/lib/theme/NotFound.js +44 -49
  306. package/lib/theme/PaginatorNavLink/index.d.ts +9 -0
  307. package/lib/theme/PaginatorNavLink/index.js +23 -0
  308. package/lib/theme/SearchBar.d.ts +7 -0
  309. package/lib/theme/SearchBar.js +11 -15
  310. package/lib/theme/SearchMetadata/index.d.ts +9 -0
  311. package/lib/theme/SearchMetadata/index.js +34 -0
  312. package/lib/theme/SiteMetadata/index.d.ts +8 -0
  313. package/lib/theme/SiteMetadata/index.js +116 -0
  314. package/lib/theme/SkipToContent/index.d.ts +8 -0
  315. package/lib/theme/SkipToContent/index.js +16 -54
  316. package/lib/theme/SkipToContent/styles.module.css +7 -0
  317. package/lib/theme/TOC/index.d.ts +9 -0
  318. package/lib/theme/TOC/index.js +18 -52
  319. package/lib/theme/TOC/styles.module.css +1 -1
  320. package/lib/theme/TOCCollapsible/CollapseButton/index.d.ts +9 -0
  321. package/lib/theme/TOCCollapsible/CollapseButton/index.js +29 -0
  322. package/lib/theme/TOCCollapsible/CollapseButton/styles.module.css +29 -0
  323. package/lib/theme/TOCCollapsible/index.d.ts +9 -0
  324. package/lib/theme/TOCCollapsible/index.js +42 -0
  325. package/lib/theme/TOCCollapsible/styles.module.css +31 -0
  326. package/lib/theme/TOCInline/index.d.ts +9 -0
  327. package/lib/theme/TOCInline/index.js +15 -46
  328. package/lib/theme/TOCItems/Tree.d.ts +11 -0
  329. package/lib/theme/TOCItems/Tree.js +37 -0
  330. package/lib/theme/TOCItems/index.d.ts +9 -0
  331. package/lib/theme/TOCItems/index.js +53 -0
  332. package/lib/theme/TabItem/index.d.ts +9 -0
  333. package/lib/theme/TabItem/index.js +11 -24
  334. package/lib/theme/TabItem/styles.module.css +10 -0
  335. package/lib/theme/Tabs/index.d.ts +9 -0
  336. package/lib/theme/Tabs/index.js +159 -123
  337. package/lib/theme/Tabs/styles.module.css +4 -13
  338. package/lib/theme/Tag/index.d.ts +9 -0
  339. package/lib/theme/Tag/index.js +23 -0
  340. package/lib/theme/Tag/styles.module.css +70 -0
  341. package/lib/theme/TagsListByLetter/index.d.ts +9 -0
  342. package/lib/theme/TagsListByLetter/index.js +38 -0
  343. package/lib/theme/TagsListByLetter/styles.module.css +11 -0
  344. package/lib/theme/TagsListInline/index.d.ts +9 -0
  345. package/lib/theme/TagsListInline/index.js +31 -0
  346. package/lib/theme/TagsListInline/styles.module.css +15 -0
  347. package/lib/theme/ThemedImage/index.d.ts +9 -0
  348. package/lib/theme/ThemedImage/index.js +33 -43
  349. package/lib/theme/ThemedImage/styles.module.css +2 -2
  350. package/lib/theme/prism-include-languages.d.ts +8 -0
  351. package/lib/theme/prism-include-languages.js +19 -33
  352. package/lib/translations.d.ts +15 -0
  353. package/lib/translations.js +122 -122
  354. package/lib/validateThemeConfig.d.ts +12 -0
  355. package/lib/validateThemeConfig.js +362 -284
  356. package/package.json +41 -36
  357. package/src/deps.d.ts +13 -0
  358. package/src/getSwizzleConfig.ts +245 -0
  359. package/src/index.ts +57 -76
  360. package/src/nprogress.css +41 -0
  361. package/src/nprogress.ts +31 -0
  362. package/{lib-next/prism-include-languages.js → src/prism-include-languages.ts} +0 -0
  363. package/src/theme/Admonition/index.tsx +209 -0
  364. package/src/theme/Admonition/styles.module.css +38 -0
  365. package/src/theme/AnnouncementBar/index.tsx +11 -16
  366. package/src/theme/AnnouncementBar/styles.module.css +23 -32
  367. package/src/theme/BackToTopButton/index.tsx +35 -0
  368. package/src/theme/BackToTopButton/styles.module.css +44 -0
  369. package/src/theme/BlogArchivePage/index.tsx +92 -0
  370. package/src/theme/BlogLayout/index.tsx +38 -0
  371. package/src/theme/BlogListPage/index.tsx +37 -36
  372. package/src/theme/BlogListPaginator/index.tsx +27 -32
  373. package/src/theme/BlogPostItem/Container/index.tsx +32 -0
  374. package/src/theme/BlogPostItem/Content/index.tsx +29 -0
  375. package/src/theme/BlogPostItem/Footer/ReadMoreLink/index.tsx +44 -0
  376. package/src/theme/BlogPostItem/Footer/index.tsx +60 -0
  377. package/src/theme/BlogPostItem/Footer/styles.module.css +10 -0
  378. package/src/theme/BlogPostItem/Header/Author/index.tsx +55 -0
  379. package/src/theme/BlogPostItem/Header/Authors/index.tsx +53 -0
  380. package/src/theme/BlogPostItem/Header/Authors/styles.module.css +21 -0
  381. package/src/theme/BlogPostItem/Header/Info/index.tsx +71 -0
  382. package/src/theme/BlogPostItem/Header/Info/styles.module.css +10 -0
  383. package/src/theme/BlogPostItem/Header/Title/index.tsx +33 -0
  384. package/{lib-next/theme/BlogPostItem → src/theme/BlogPostItem/Header/Title}/styles.module.css +8 -7
  385. package/src/theme/BlogPostItem/Header/index.tsx +21 -0
  386. package/src/theme/BlogPostItem/index.tsx +19 -151
  387. package/src/theme/BlogPostItems/index.tsx +30 -0
  388. package/src/theme/BlogPostPage/Metadata/index.tsx +44 -0
  389. package/src/theme/BlogPostPage/index.tsx +55 -42
  390. package/src/theme/BlogPostPaginator/index.tsx +27 -36
  391. package/src/theme/BlogSidebar/Desktop/index.tsx +45 -0
  392. package/src/theme/BlogSidebar/{styles.module.css → Desktop/styles.module.css} +5 -4
  393. package/src/theme/BlogSidebar/Mobile/index.tsx +38 -0
  394. package/src/theme/BlogSidebar/index.tsx +10 -33
  395. package/src/theme/BlogTagsListPage/index.tsx +24 -67
  396. package/src/theme/BlogTagsPostsPage/index.tsx +58 -50
  397. package/src/theme/CodeBlock/Container/index.tsx +32 -0
  398. package/src/theme/CodeBlock/Container/styles.module.css +14 -0
  399. package/src/theme/CodeBlock/Content/Element.tsx +30 -0
  400. package/src/theme/CodeBlock/Content/String.tsx +110 -0
  401. package/src/theme/CodeBlock/{styles.module.css → Content/styles.module.css} +45 -27
  402. package/src/theme/CodeBlock/CopyButton/index.tsx +68 -0
  403. package/src/theme/CodeBlock/CopyButton/styles.module.css +47 -0
  404. package/src/theme/CodeBlock/Line/index.tsx +49 -0
  405. package/src/theme/CodeBlock/Line/styles.module.css +51 -0
  406. package/src/theme/CodeBlock/WordWrapButton/index.tsx +49 -0
  407. package/src/theme/CodeBlock/WordWrapButton/styles.module.css +15 -0
  408. package/src/theme/CodeBlock/index.tsx +29 -253
  409. package/src/theme/ColorModeToggle/index.tsx +67 -0
  410. package/src/theme/ColorModeToggle/styles.module.css +35 -0
  411. package/src/theme/Details/index.tsx +26 -0
  412. package/src/theme/Details/styles.module.css +13 -0
  413. package/src/theme/DocBreadcrumbs/index.tsx +141 -0
  414. package/src/theme/DocBreadcrumbs/styles.module.css +19 -0
  415. package/src/theme/DocCard/index.tsx +120 -0
  416. package/src/theme/DocCard/styles.module.css +34 -0
  417. package/src/theme/DocCardList/index.tsx +35 -0
  418. package/src/theme/DocCategoryGeneratedIndexPage/index.tsx +86 -0
  419. package/src/theme/DocCategoryGeneratedIndexPage/styles.module.css +26 -0
  420. package/src/theme/DocItem/Content/index.tsx +48 -0
  421. package/src/theme/DocItem/Footer/index.tsx +89 -0
  422. package/{lib-next/theme/DocItem → src/theme/DocItem/Footer}/styles.module.css +1 -9
  423. package/src/theme/DocItem/Layout/index.tsx +68 -0
  424. package/src/theme/DocItem/Layout/styles.module.css +17 -0
  425. package/src/theme/DocItem/Metadata/index.tsx +22 -0
  426. package/src/theme/DocItem/Paginator/index.tsx +19 -0
  427. package/src/theme/DocItem/TOC/Desktop/index.tsx +24 -0
  428. package/src/theme/DocItem/TOC/Mobile/index.tsx +27 -0
  429. package/src/theme/DocItem/TOC/Mobile/styles.module.css +19 -0
  430. package/src/theme/DocItem/index.tsx +15 -102
  431. package/src/theme/DocPage/Layout/Main/index.tsx +36 -0
  432. package/src/theme/DocPage/Layout/Main/styles.module.css +28 -0
  433. package/src/theme/DocPage/Layout/Sidebar/ExpandButton/index.tsx +40 -0
  434. package/src/theme/DocPage/Layout/Sidebar/ExpandButton/styles.module.css +33 -0
  435. package/src/theme/DocPage/Layout/Sidebar/index.tsx +74 -0
  436. package/src/theme/DocPage/Layout/Sidebar/styles.module.css +32 -0
  437. package/src/theme/DocPage/Layout/index.tsx +38 -0
  438. package/src/theme/DocPage/Layout/styles.module.css +15 -0
  439. package/src/theme/DocPage/index.tsx +38 -167
  440. package/src/theme/DocPaginator/index.tsx +28 -40
  441. package/src/theme/DocSidebar/Desktop/CollapseButton/index.tsx +38 -0
  442. package/src/theme/DocSidebar/Desktop/CollapseButton/styles.module.css +46 -0
  443. package/src/theme/DocSidebar/Desktop/Content/index.tsx +55 -0
  444. package/src/theme/DocSidebar/Desktop/Content/styles.module.css +23 -0
  445. package/src/theme/DocSidebar/Desktop/index.tsx +40 -0
  446. package/src/theme/DocSidebar/Desktop/styles.module.css +50 -0
  447. package/src/theme/DocSidebar/Mobile/index.tsx +54 -0
  448. package/src/theme/DocSidebar/index.tsx +14 -350
  449. package/src/theme/DocSidebarItem/Category/index.tsx +211 -0
  450. package/src/theme/DocSidebarItem/Html/index.tsx +34 -0
  451. package/src/theme/DocSidebarItem/Html/styles.module.css +13 -0
  452. package/src/theme/DocSidebarItem/Link/index.tsx +58 -0
  453. package/src/theme/DocSidebarItem/Link/styles.module.css +10 -0
  454. package/src/theme/DocSidebarItem/index.tsx +27 -0
  455. package/src/theme/DocSidebarItems/index.tsx +27 -0
  456. package/src/theme/DocTagDocListPage/index.tsx +95 -0
  457. package/src/theme/DocTagsListPage/index.tsx +43 -0
  458. package/src/theme/DocVersionBadge/index.tsx +36 -0
  459. package/src/theme/DocVersionBanner/index.tsx +53 -28
  460. package/src/theme/EditThisPage/index.tsx +7 -3
  461. package/src/theme/ErrorPageContent.tsx +41 -0
  462. package/src/theme/Footer/Copyright/index.tsx +20 -0
  463. package/src/theme/Footer/Layout/index.tsx +34 -0
  464. package/src/theme/Footer/LinkItem/index.tsx +36 -0
  465. package/src/theme/Footer/Links/MultiColumn/index.tsx +51 -0
  466. package/src/theme/Footer/Links/Simple/index.tsx +42 -0
  467. package/src/theme/Footer/Links/index.tsx +21 -0
  468. package/src/theme/Footer/Logo/index.tsx +46 -0
  469. package/{lib/theme/Footer → src/theme/Footer/Logo}/styles.module.css +2 -1
  470. package/src/theme/Footer/index.tsx +13 -113
  471. package/src/theme/Heading/index.tsx +31 -58
  472. package/src/theme/Heading/styles.module.css +25 -5
  473. package/src/theme/{IconArrow → Icon/Arrow}/index.tsx +3 -5
  474. package/src/theme/Icon/Close/index.tsx +26 -0
  475. package/src/theme/Icon/DarkMode/index.tsx +20 -0
  476. package/src/theme/{IconEdit → Icon/Edit}/index.tsx +6 -6
  477. package/{lib/theme/IconEdit → src/theme/Icon/Edit}/styles.module.css +0 -0
  478. package/src/theme/{IconExternalLink → Icon/ExternalLink}/index.tsx +4 -6
  479. package/src/theme/{IconExternalLink → Icon/ExternalLink}/styles.module.css +0 -2
  480. package/src/theme/Icon/Home/index.tsx +20 -0
  481. package/src/theme/Icon/Language/index.tsx +29 -0
  482. package/src/theme/Icon/LightMode/index.tsx +20 -0
  483. package/src/theme/{IconMenu → Icon/Menu}/index.tsx +4 -6
  484. package/src/theme/LastUpdated/index.tsx +4 -2
  485. package/src/theme/Layout/Provider/index.tsx +33 -0
  486. package/src/theme/Layout/index.tsx +23 -15
  487. package/{lib-next/theme/Layout/styles.css → src/theme/Layout/styles.module.css} +10 -12
  488. package/src/theme/Logo/index.tsx +57 -26
  489. package/src/theme/{ThemeContext.ts → MDXComponents/A.tsx} +5 -6
  490. package/src/theme/MDXComponents/Code.tsx +40 -0
  491. package/src/theme/MDXComponents/Details.tsx +28 -0
  492. package/src/theme/MDXComponents/Head.tsx +29 -0
  493. package/src/theme/MDXComponents/Heading.tsx +14 -0
  494. package/src/theme/MDXComponents/Img/index.tsx +27 -0
  495. package/src/theme/MDXComponents/Img/styles.module.css +10 -0
  496. package/src/theme/MDXComponents/Pre.tsx +23 -0
  497. package/src/theme/MDXComponents/Ul/index.tsx +26 -0
  498. package/src/theme/MDXComponents/Ul/styles.module.css +14 -0
  499. package/src/theme/MDXComponents/index.tsx +25 -42
  500. package/src/theme/MDXContent/index.tsx +15 -0
  501. package/src/theme/MDXPage/index.tsx +40 -35
  502. package/src/theme/Navbar/ColorModeToggle/index.tsx +30 -0
  503. package/src/theme/Navbar/Content/index.tsx +86 -0
  504. package/src/theme/Navbar/Content/styles.module.css +15 -0
  505. package/src/theme/Navbar/Layout/index.tsx +57 -0
  506. package/src/theme/Navbar/{styles.module.css → Layout/styles.module.css} +0 -6
  507. package/src/theme/Navbar/Logo/index.tsx +19 -0
  508. package/src/theme/Navbar/MobileSidebar/Header/index.tsx +34 -0
  509. package/src/theme/Navbar/MobileSidebar/Layout/index.tsx +31 -0
  510. package/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx +38 -0
  511. package/src/theme/Navbar/MobileSidebar/SecondaryMenu/index.tsx +39 -0
  512. package/src/theme/Navbar/MobileSidebar/Toggle/index.tsx +25 -0
  513. package/src/theme/Navbar/MobileSidebar/index.tsx +33 -0
  514. package/src/theme/Navbar/Search/index.tsx +19 -0
  515. package/src/theme/Navbar/Search/styles.module.css +20 -0
  516. package/src/theme/Navbar/index.tsx +7 -147
  517. package/src/theme/NavbarItem/ComponentTypes.tsx +32 -0
  518. package/src/theme/NavbarItem/DefaultNavbarItem.tsx +36 -208
  519. package/src/theme/NavbarItem/DocNavbarItem.tsx +13 -41
  520. package/src/theme/NavbarItem/DocSidebarNavbarItem.tsx +36 -0
  521. package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +57 -52
  522. package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx +5 -8
  523. package/src/theme/NavbarItem/DropdownNavbarItem.tsx +190 -0
  524. package/src/theme/NavbarItem/HtmlNavbarItem.tsx +32 -0
  525. package/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx +77 -0
  526. package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  527. package/src/theme/NavbarItem/NavbarNavLink.tsx +74 -0
  528. package/src/theme/NavbarItem/SearchNavbarItem.tsx +11 -3
  529. package/src/theme/NavbarItem/index.tsx +15 -32
  530. package/src/theme/NotFound.tsx +40 -37
  531. package/src/theme/PaginatorNavLink/index.tsx +26 -0
  532. package/src/theme/SearchBar.tsx +2 -1
  533. package/src/theme/SearchMetadata/index.tsx +43 -0
  534. package/src/theme/{LayoutHead → SiteMetadata}/index.tsx +31 -45
  535. package/src/theme/SkipToContent/index.tsx +7 -32
  536. package/src/theme/SkipToContent/styles.module.css +7 -0
  537. package/src/theme/TOC/index.tsx +14 -44
  538. package/src/theme/TOC/styles.module.css +1 -1
  539. package/src/theme/TOCCollapsible/CollapseButton/index.tsx +36 -0
  540. package/src/theme/TOCCollapsible/CollapseButton/styles.module.css +29 -0
  541. package/src/theme/TOCCollapsible/index.tsx +46 -0
  542. package/src/theme/TOCCollapsible/styles.module.css +31 -0
  543. package/src/theme/TOCInline/index.tsx +15 -35
  544. package/src/theme/TOCItems/Tree.tsx +46 -0
  545. package/src/theme/TOCItems/index.tsx +61 -0
  546. package/src/theme/TabItem/index.tsx +12 -4
  547. package/src/theme/TabItem/styles.module.css +10 -0
  548. package/src/theme/Tabs/index.tsx +121 -62
  549. package/src/theme/Tabs/styles.module.css +4 -13
  550. package/src/theme/Tag/index.tsx +27 -0
  551. package/src/theme/Tag/styles.module.css +70 -0
  552. package/src/theme/TagsListByLetter/index.tsx +43 -0
  553. package/src/theme/TagsListByLetter/styles.module.css +11 -0
  554. package/src/theme/TagsListInline/index.tsx +35 -0
  555. package/src/theme/TagsListInline/styles.module.css +15 -0
  556. package/src/theme/ThemedImage/index.tsx +10 -12
  557. package/src/theme/ThemedImage/styles.module.css +2 -2
  558. package/src/theme/prism-include-languages.ts +20 -15
  559. package/src/theme-classic.d.ts +1364 -0
  560. package/src/translations.ts +85 -60
  561. package/src/validateThemeConfig.ts +444 -0
  562. package/babel.config.js +0 -35
  563. package/codeTranslations/README.md +0 -20
  564. package/codeTranslations/ar.json +0 -57
  565. package/codeTranslations/base.json +0 -112
  566. package/codeTranslations/bn.json +0 -56
  567. package/codeTranslations/da.json +0 -57
  568. package/codeTranslations/de.json +0 -57
  569. package/codeTranslations/es.json +0 -57
  570. package/codeTranslations/fa.json +0 -57
  571. package/codeTranslations/fil.json +0 -57
  572. package/codeTranslations/fr.json +0 -57
  573. package/codeTranslations/he.json +0 -57
  574. package/codeTranslations/hi.json +0 -57
  575. package/codeTranslations/ja.json +0 -57
  576. package/codeTranslations/ko.json +0 -57
  577. package/codeTranslations/pl.json +0 -57
  578. package/codeTranslations/pt-BR.json +0 -57
  579. package/codeTranslations/pt-PT.json +0 -57
  580. package/codeTranslations/ru.json +0 -57
  581. package/codeTranslations/tr.json +0 -57
  582. package/codeTranslations/vi.json +0 -57
  583. package/codeTranslations/zh-Hans.json +0 -57
  584. package/codeTranslations/zh-Hant.json +0 -57
  585. package/lib/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  586. package/lib/__tests__/translations.test.js +0 -112
  587. package/lib/__tests__/validateThemeConfig.test.js +0 -333
  588. package/lib/theme/BlogSidebar/styles.module.css +0 -44
  589. package/lib/theme/CodeBlock/styles.module.css +0 -68
  590. package/lib/theme/DocPage/styles.module.css +0 -86
  591. package/lib/theme/DocSidebar/styles.module.css +0 -124
  592. package/lib/theme/DocVersionSuggestions/index.js +0 -111
  593. package/lib/theme/Heading/styles.css +0 -23
  594. package/lib/theme/IconArrow/index.js +0 -28
  595. package/lib/theme/IconEdit/index.js +0 -34
  596. package/lib/theme/IconExternalLink/index.js +0 -30
  597. package/lib/theme/IconLanguage/index.js +0 -29
  598. package/lib/theme/IconMenu/index.js +0 -30
  599. package/lib/theme/LayoutHead/index.js +0 -144
  600. package/lib/theme/LayoutProviders/index.js +0 -36
  601. package/lib/theme/Navbar/styles.module.css +0 -20
  602. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem.js +0 -72
  603. package/lib/theme/SearchMetadatas/index.js +0 -33
  604. package/lib/theme/Seo/index.js +0 -49
  605. package/lib/theme/ThemeContext.js +0 -21
  606. package/lib/theme/ThemeProvider/index.js +0 -38
  607. package/lib/theme/Toggle/index.js +0 -94
  608. package/lib/theme/Toggle/styles.css +0 -103
  609. package/lib/theme/Toggle/styles.module.css +0 -17
  610. package/lib/theme/UserPreferencesContext.js +0 -18
  611. package/lib/theme/UserPreferencesProvider/index.js +0 -36
  612. package/lib/theme/hooks/styles.css +0 -10
  613. package/lib/theme/hooks/useAnnouncementBar.js +0 -63
  614. package/lib/theme/hooks/useContextualSearchFilters.js +0 -47
  615. package/lib/theme/hooks/useDocs.js +0 -18
  616. package/lib/theme/hooks/useHideableNavbar.js +0 -92
  617. package/lib/theme/hooks/useKeyboardNavigation.js +0 -45
  618. package/lib/theme/hooks/useLocationHash.js +0 -28
  619. package/lib/theme/hooks/useLockBodyScroll.js +0 -26
  620. package/lib/theme/hooks/usePrismTheme.js +0 -36
  621. package/lib/theme/hooks/useScrollPosition.js +0 -49
  622. package/lib/theme/hooks/useTOCHighlight.js +0 -87
  623. package/lib/theme/hooks/useTabGroupChoice.js +0 -51
  624. package/lib/theme/hooks/useTheme.js +0 -99
  625. package/lib/theme/hooks/useThemeContext.js +0 -31
  626. package/lib/theme/hooks/useUserPreferencesContext.js +0 -31
  627. package/lib/theme/hooks/useWindowSize.js +0 -55
  628. package/lib/types.d.ts +0 -598
  629. package/lib-next/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  630. package/lib-next/__tests__/translations.test.js +0 -128
  631. package/lib-next/__tests__/validateThemeConfig.test.js +0 -333
  632. package/lib-next/index.js +0 -221
  633. package/lib-next/theme/AnnouncementBar/index.js +0 -61
  634. package/lib-next/theme/AnnouncementBar/styles.module.css +0 -72
  635. package/lib-next/theme/BlogListPage/index.js +0 -56
  636. package/lib-next/theme/BlogListPaginator/index.js +0 -54
  637. package/lib-next/theme/BlogPostItem/index.js +0 -168
  638. package/lib-next/theme/BlogPostPage/index.js +0 -55
  639. package/lib-next/theme/BlogPostPaginator/index.js +0 -57
  640. package/lib-next/theme/BlogTagsListPage/index.js +0 -75
  641. package/lib-next/theme/BlogTagsPostsPage/index.js +0 -92
  642. package/lib-next/theme/CodeBlock/index.js +0 -268
  643. package/lib-next/theme/DocItem/index.js +0 -117
  644. package/lib-next/theme/DocPage/index.js +0 -173
  645. package/lib-next/theme/DocPage/styles.module.css +0 -86
  646. package/lib-next/theme/DocPaginator/index.js +0 -59
  647. package/lib-next/theme/DocSidebar/index.js +0 -351
  648. package/lib-next/theme/DocSidebar/styles.module.css +0 -124
  649. package/lib-next/theme/DocVersionBanner/index.js +0 -127
  650. package/lib-next/theme/DocVersionSuggestions/index.js +0 -126
  651. package/lib-next/theme/EditThisPage/index.js +0 -21
  652. package/lib-next/theme/Footer/index.js +0 -120
  653. package/lib-next/theme/Heading/index.js +0 -67
  654. package/lib-next/theme/IconLanguage/index.js +0 -25
  655. package/lib-next/theme/LastUpdated/index.js +0 -77
  656. package/lib-next/theme/Layout/index.js +0 -46
  657. package/lib-next/theme/LayoutHead/index.js +0 -137
  658. package/lib-next/theme/LayoutProviders/index.js +0 -26
  659. package/lib-next/theme/Logo/index.js +0 -54
  660. package/lib-next/theme/MDXComponents/index.js +0 -51
  661. package/lib-next/theme/MDXPage/index.js +0 -51
  662. package/lib-next/theme/Navbar/index.js +0 -146
  663. package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +0 -227
  664. package/lib-next/theme/NavbarItem/DocNavbarItem.js +0 -57
  665. package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +0 -83
  666. package/lib-next/theme/NavbarItem/DocsVersionNavbarItem.js +0 -28
  667. package/lib-next/theme/NavbarItem/LocaleDropdownNavbarItem.js +0 -66
  668. package/lib-next/theme/NavbarItem/index.js +0 -41
  669. package/lib-next/theme/NotFound.js +0 -50
  670. package/lib-next/theme/SearchBar.js +0 -11
  671. package/lib-next/theme/SearchMetadatas/index.js +0 -20
  672. package/lib-next/theme/Seo/index.js +0 -36
  673. package/lib-next/theme/SkipToContent/index.js +0 -50
  674. package/lib-next/theme/SkipToContent/styles.module.css +0 -14
  675. package/lib-next/theme/TOC/index.js +0 -52
  676. package/lib-next/theme/TOC/styles.module.css +0 -23
  677. package/lib-next/theme/TOCInline/index.js +0 -43
  678. package/lib-next/theme/Tabs/index.js +0 -144
  679. package/lib-next/theme/Tabs/styles.module.css +0 -23
  680. package/lib-next/theme/ThemeProvider/index.js +0 -25
  681. package/lib-next/theme/ThemedImage/index.js +0 -41
  682. package/lib-next/theme/ThemedImage/styles.module.css +0 -18
  683. package/lib-next/theme/Toggle/index.js +0 -80
  684. package/lib-next/theme/Toggle/styles.css +0 -103
  685. package/lib-next/theme/UserPreferencesContext.js +0 -9
  686. package/lib-next/theme/UserPreferencesProvider/index.js +0 -24
  687. package/lib-next/theme/hooks/useAnnouncementBar.js +0 -49
  688. package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
  689. package/lib-next/theme/hooks/useDocs.js +0 -10
  690. package/lib-next/theme/hooks/useHideableNavbar.js +0 -79
  691. package/lib-next/theme/hooks/useKeyboardNavigation.js +0 -35
  692. package/lib-next/theme/hooks/useLocationHash.js +0 -20
  693. package/lib-next/theme/hooks/useLockBodyScroll.js +0 -18
  694. package/lib-next/theme/hooks/usePrismTheme.js +0 -20
  695. package/lib-next/theme/hooks/useScrollPosition.js +0 -38
  696. package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
  697. package/lib-next/theme/hooks/useTabGroupChoice.js +0 -39
  698. package/lib-next/theme/hooks/useTheme.js +0 -82
  699. package/lib-next/theme/hooks/useThemeContext.js +0 -22
  700. package/lib-next/theme/hooks/useUserPreferencesContext.js +0 -22
  701. package/lib-next/theme/hooks/useWindowSize.js +0 -45
  702. package/lib-next/theme/prism-include-languages.js +0 -23
  703. package/lib-next/translations.js +0 -145
  704. package/lib-next/types.d.ts +0 -598
  705. package/lib-next/validateThemeConfig.js +0 -317
  706. package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  707. package/src/__tests__/translations.test.ts +0 -116
  708. package/src/__tests__/validateThemeConfig.test.js +0 -333
  709. package/src/prism-include-languages.js +0 -11
  710. package/src/theme/DocPage/styles.module.css +0 -86
  711. package/src/theme/DocSidebar/styles.module.css +0 -124
  712. package/src/theme/Heading/styles.css +0 -23
  713. package/src/theme/IconLanguage/index.tsx +0 -31
  714. package/src/theme/Layout/styles.css +0 -27
  715. package/src/theme/LayoutProviders/index.tsx +0 -29
  716. package/src/theme/NavbarItem/LocaleDropdownNavbarItem.tsx +0 -67
  717. package/src/theme/SearchMetadatas/index.tsx +0 -28
  718. package/src/theme/Seo/index.tsx +0 -46
  719. package/src/theme/ThemeProvider/index.tsx +0 -24
  720. package/src/theme/Toggle/index.tsx +0 -100
  721. package/src/theme/Toggle/styles.css +0 -103
  722. package/src/theme/Toggle/styles.module.css +0 -17
  723. package/src/theme/UserPreferencesContext.ts +0 -12
  724. package/src/theme/UserPreferencesProvider/index.tsx +0 -27
  725. package/src/theme/hooks/styles.css +0 -10
  726. package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
  727. package/src/theme/hooks/useDocs.ts +0 -11
  728. package/src/theme/hooks/useHideableNavbar.ts +0 -85
  729. package/src/theme/hooks/useKeyboardNavigation.ts +0 -39
  730. package/src/theme/hooks/useLocationHash.ts +0 -25
  731. package/src/theme/hooks/usePrismTheme.ts +0 -22
  732. package/src/theme/hooks/useScrollPosition.ts +0 -45
  733. package/src/theme/hooks/useTOCHighlight.ts +0 -98
  734. package/src/theme/hooks/useTabGroupChoice.ts +0 -46
  735. package/src/theme/hooks/useTheme.ts +0 -92
  736. package/src/theme/hooks/useThemeContext.ts +0 -23
  737. package/src/theme/hooks/useUserPreferencesContext.ts +0 -25
  738. package/src/theme/hooks/useWindowSize.ts +0 -51
  739. package/src/types.d.ts +0 -598
  740. package/src/validateThemeConfig.js +0 -317
  741. package/tsconfig.json +0 -12
  742. package/update-code-translations.js +0 -240
  743. package/update-code-translations.test.js +0 -33
@@ -5,40 +5,41 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- import {TranslationFile, TranslationFileContent} from '@docusaurus/types';
9
- import {
8
+ import _ from 'lodash';
9
+ import {mergeTranslations} from '@docusaurus/utils';
10
+ import type {TranslationFile, TranslationFileContent} from '@docusaurus/types';
11
+ import type {
10
12
  ThemeConfig,
11
13
  Navbar,
12
14
  NavbarItem,
13
15
  Footer,
16
+ MultiColumnFooter,
17
+ SimpleFooter,
14
18
  } from '@docusaurus/theme-common';
15
19
 
16
- import {keyBy, chain, flatten} from 'lodash';
17
- import {mergeTranslations} from '@docusaurus/utils';
18
-
19
20
  function getNavbarTranslationFile(navbar: Navbar): TranslationFileContent {
20
21
  // TODO handle properly all the navbar item types here!
21
22
  function flattenNavbarItems(items: NavbarItem[]): NavbarItem[] {
22
- const subItems = flatten(
23
- items.map((item) => {
24
- const allSubItems = flatten([item.items ?? []]);
25
- return flattenNavbarItems(allSubItems);
26
- }),
27
- );
23
+ const subItems = items.flatMap((item) => {
24
+ const allSubItems = [item.items ?? []].flat();
25
+ return flattenNavbarItems(allSubItems);
26
+ });
28
27
  return [...items, ...subItems];
29
28
  }
30
29
 
31
30
  const allNavbarItems = flattenNavbarItems(navbar.items);
32
31
 
33
- const navbarItemsTranslations: TranslationFileContent = chain(
34
- allNavbarItems.filter((navbarItem) => !!navbarItem.label),
35
- )
36
- .keyBy((navbarItem) => `item.label.${navbarItem.label}`)
37
- .mapValues((navbarItem) => ({
38
- message: navbarItem.label!,
39
- description: `Navbar item with label ${navbarItem.label}`,
40
- }))
41
- .value();
32
+ const navbarItemsTranslations: TranslationFileContent = Object.fromEntries(
33
+ allNavbarItems
34
+ .filter((navbarItem) => navbarItem.label)
35
+ .map((navbarItem) => [
36
+ `item.label.${navbarItem.label}`,
37
+ {
38
+ message: navbarItem.label!,
39
+ description: `Navbar item with label ${navbarItem.label}`,
40
+ },
41
+ ]),
42
+ );
42
43
 
43
44
  const titleTranslations: TranslationFileContent = navbar.title
44
45
  ? {title: {message: navbar.title, description: 'The title in the navbar'}}
@@ -48,8 +49,11 @@ function getNavbarTranslationFile(navbar: Navbar): TranslationFileContent {
48
49
  }
49
50
  function translateNavbar(
50
51
  navbar: Navbar,
51
- navbarTranslations: TranslationFileContent,
52
+ navbarTranslations: TranslationFileContent | undefined,
52
53
  ): Navbar {
54
+ if (!navbarTranslations) {
55
+ return navbar;
56
+ }
53
57
  return {
54
58
  ...navbar,
55
59
  title: navbarTranslations.title?.message ?? navbar.title,
@@ -71,31 +75,40 @@ function translateNavbar(
71
75
  };
72
76
  }
73
77
 
78
+ function isMultiColumnFooterLinks(
79
+ links: MultiColumnFooter['links'] | SimpleFooter['links'],
80
+ ): links is MultiColumnFooter['links'] {
81
+ return links.length > 0 && 'title' in links[0]!;
82
+ }
83
+
74
84
  function getFooterTranslationFile(footer: Footer): TranslationFileContent {
75
- // TODO POC code
76
- const footerLinkTitles: TranslationFileContent = chain(
77
- footer.links.filter((link) => !!link.title),
78
- )
79
- .keyBy((link) => `link.title.${link.title}`)
80
- .mapValues((link) => ({
81
- message: link.title!,
82
- description: `The title of the footer links column with title=${link.title} in the footer`,
83
- }))
84
- .value();
85
-
86
- const footerLinkLabels: TranslationFileContent = chain(
87
- flatten(footer.links.map((link) => link.items)).filter(
88
- (link) => !!link.label,
89
- ),
90
- )
91
- .keyBy((linkItem) => `link.item.label.${linkItem.label}`)
92
- .mapValues((linkItem) => ({
93
- message: linkItem.label!,
94
- description: `The label of footer link with label=${
95
- linkItem.label
96
- } linking to ${linkItem.to ?? linkItem.href}`,
97
- }))
98
- .value();
85
+ const footerLinkTitles: TranslationFileContent = Object.fromEntries(
86
+ (isMultiColumnFooterLinks(footer.links)
87
+ ? footer.links.filter((link) => link.title)
88
+ : []
89
+ ).map((link) => [
90
+ `link.title.${link.title}`,
91
+ {
92
+ message: link.title!,
93
+ description: `The title of the footer links column with title=${link.title} in the footer`,
94
+ },
95
+ ]),
96
+ );
97
+
98
+ const footerLinkLabels: TranslationFileContent = Object.fromEntries(
99
+ (isMultiColumnFooterLinks(footer.links)
100
+ ? footer.links.flatMap((link) => link.items).filter((link) => link.label)
101
+ : footer.links.filter((link) => link.label)
102
+ ).map((link) => [
103
+ `link.item.label.${link.label}`,
104
+ {
105
+ message: link.label!,
106
+ description: `The label of footer link with label=${
107
+ link.label
108
+ } linking to ${link.to ?? link.href}`,
109
+ },
110
+ ]),
111
+ );
99
112
 
100
113
  const copyright: TranslationFileContent = footer.copyright
101
114
  ? {
@@ -110,19 +123,29 @@ function getFooterTranslationFile(footer: Footer): TranslationFileContent {
110
123
  }
111
124
  function translateFooter(
112
125
  footer: Footer,
113
- footerTranslations: TranslationFileContent,
126
+ footerTranslations: TranslationFileContent | undefined,
114
127
  ): Footer {
115
- const links = footer.links.map((link) => ({
116
- ...link,
117
- title:
118
- footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
119
- items: link.items.map((linkItem) => ({
120
- ...linkItem,
121
- label:
122
- footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
123
- linkItem.label,
124
- })),
125
- }));
128
+ if (!footerTranslations) {
129
+ return footer;
130
+ }
131
+ const links = isMultiColumnFooterLinks(footer.links)
132
+ ? footer.links.map((link) => ({
133
+ ...link,
134
+ title:
135
+ footerTranslations[`link.title.${link.title}`]?.message ?? link.title,
136
+ items: link.items.map((linkItem) => ({
137
+ ...linkItem,
138
+ label:
139
+ footerTranslations[`link.item.label.${linkItem.label}`]?.message ??
140
+ linkItem.label,
141
+ })),
142
+ }))
143
+ : footer.links.map((link) => ({
144
+ ...link,
145
+ label:
146
+ footerTranslations[`link.item.label.${link.label}`]?.message ??
147
+ link.label,
148
+ }));
126
149
 
127
150
  const copyright = footerTranslations.copyright?.message ?? footer.copyright;
128
151
 
@@ -155,10 +178,12 @@ export function translateThemeConfig({
155
178
  themeConfig,
156
179
  translationFiles,
157
180
  }: {
181
+ // To make TS correctly figure out the contravariance in parameter.
182
+ // In practice it's always normalized
158
183
  themeConfig: ThemeConfig;
159
184
  translationFiles: TranslationFile[];
160
185
  }): ThemeConfig {
161
- const translationFilesMap: Record<string, TranslationFile> = keyBy(
186
+ const translationFilesMap: {[fileName: string]: TranslationFile} = _.keyBy(
162
187
  translationFiles,
163
188
  (f) => f.path,
164
189
  );
@@ -167,10 +192,10 @@ export function translateThemeConfig({
167
192
  ...themeConfig,
168
193
  navbar: translateNavbar(
169
194
  themeConfig.navbar,
170
- translationFilesMap.navbar.content,
195
+ translationFilesMap.navbar?.content,
171
196
  ),
172
197
  footer: themeConfig.footer
173
- ? translateFooter(themeConfig.footer, translationFilesMap.footer.content)
198
+ ? translateFooter(themeConfig.footer, translationFilesMap.footer?.content)
174
199
  : undefined,
175
200
  };
176
201
  }
@@ -0,0 +1,444 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+
8
+ import defaultPrismTheme from 'prism-react-renderer/themes/palenight';
9
+ import {Joi, URISchema} from '@docusaurus/utils-validation';
10
+ import type {ThemeConfig} from '@docusaurus/theme-common';
11
+ import type {ThemeConfigValidationContext} from '@docusaurus/types';
12
+
13
+ const DEFAULT_DOCS_CONFIG: ThemeConfig['docs'] = {
14
+ versionPersistence: 'localStorage',
15
+ sidebar: {
16
+ hideable: false,
17
+ autoCollapseCategories: false,
18
+ },
19
+ };
20
+ const DocsSchema = Joi.object({
21
+ versionPersistence: Joi.string()
22
+ .equal('localStorage', 'none')
23
+ .default(DEFAULT_DOCS_CONFIG.versionPersistence),
24
+ sidebar: Joi.object({
25
+ hideable: Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.hideable),
26
+ autoCollapseCategories: Joi.bool().default(
27
+ DEFAULT_DOCS_CONFIG.sidebar.autoCollapseCategories,
28
+ ),
29
+ }).default(DEFAULT_DOCS_CONFIG.sidebar),
30
+ }).default(DEFAULT_DOCS_CONFIG);
31
+
32
+ const DEFAULT_COLOR_MODE_CONFIG: ThemeConfig['colorMode'] = {
33
+ defaultMode: 'light',
34
+ disableSwitch: false,
35
+ respectPrefersColorScheme: false,
36
+ };
37
+
38
+ export const DEFAULT_CONFIG: ThemeConfig = {
39
+ colorMode: DEFAULT_COLOR_MODE_CONFIG,
40
+ docs: DEFAULT_DOCS_CONFIG,
41
+ metadata: [],
42
+ prism: {
43
+ additionalLanguages: [],
44
+ theme: defaultPrismTheme,
45
+ magicComments: [
46
+ {
47
+ className: 'theme-code-block-highlighted-line',
48
+ line: 'highlight-next-line',
49
+ block: {start: 'highlight-start', end: 'highlight-end'},
50
+ },
51
+ ],
52
+ },
53
+ navbar: {
54
+ hideOnScroll: false,
55
+ items: [],
56
+ },
57
+ tableOfContents: {
58
+ minHeadingLevel: 2,
59
+ maxHeadingLevel: 3,
60
+ },
61
+ };
62
+
63
+ const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
64
+
65
+ const NavbarItemBaseSchema = Joi.object({
66
+ label: Joi.string(),
67
+ html: Joi.string(),
68
+ className: Joi.string(),
69
+ })
70
+ .nand('html', 'label')
71
+ // We allow any unknown attributes on the links (users may need additional
72
+ // attributes like target, aria-role, data-customAttribute...)
73
+ .unknown();
74
+
75
+ const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
76
+ to: Joi.string(),
77
+ href: URISchema,
78
+ activeBasePath: Joi.string(),
79
+ activeBaseRegex: Joi.string(),
80
+ prependBaseUrlToHref: Joi.bool(),
81
+ // This is only triggered in case of a nested dropdown
82
+ items: Joi.forbidden().messages({
83
+ 'any.unknown': 'Nested dropdowns are not allowed',
84
+ }),
85
+ })
86
+ .xor('href', 'to')
87
+ .messages({
88
+ 'object.xor': 'One and only one between "to" and "href" should be provided',
89
+ });
90
+
91
+ const DocsVersionNavbarItemSchema = NavbarItemBaseSchema.append({
92
+ type: Joi.string().equal('docsVersion').required(),
93
+ to: Joi.string(),
94
+ docsPluginId: Joi.string(),
95
+ });
96
+
97
+ const DocItemSchema = NavbarItemBaseSchema.append({
98
+ type: Joi.string().equal('doc').required(),
99
+ docId: Joi.string().required(),
100
+ docsPluginId: Joi.string(),
101
+ });
102
+
103
+ const DocSidebarItemSchema = NavbarItemBaseSchema.append({
104
+ type: Joi.string().equal('docSidebar').required(),
105
+ sidebarId: Joi.string().required(),
106
+ docsPluginId: Joi.string(),
107
+ });
108
+
109
+ const HtmlNavbarItemSchema = Joi.object({
110
+ className: Joi.string(),
111
+ type: Joi.string().equal('html').required(),
112
+ value: Joi.string().required(),
113
+ });
114
+
115
+ // A temporary workaround to allow users to add custom navbar items
116
+ // See https://github.com/facebook/docusaurus/issues/7227
117
+ const CustomNavbarItemRegexp = /custom-.*/;
118
+ const CustomNavbarItemSchema = Joi.object({
119
+ type: Joi.string().regex(CustomNavbarItemRegexp).required(),
120
+ }).unknown();
121
+
122
+ const itemWithType = (type: string | RegExp | undefined) => {
123
+ // Because equal(undefined) is not supported :/
124
+ const typeSchema =
125
+ // eslint-disable-next-line no-nested-ternary
126
+ type instanceof RegExp
127
+ ? Joi.string().required().regex(type)
128
+ : type
129
+ ? Joi.string().required().equal(type)
130
+ : Joi.string().forbidden();
131
+ return Joi.object({
132
+ type: typeSchema,
133
+ })
134
+ .unknown()
135
+ .required();
136
+ };
137
+
138
+ const DropdownSubitemSchema = Joi.object({
139
+ position: Joi.forbidden(),
140
+ }).when('.', {
141
+ switch: [
142
+ {
143
+ is: itemWithType('docsVersion'),
144
+ then: DocsVersionNavbarItemSchema,
145
+ },
146
+ {
147
+ is: itemWithType('doc'),
148
+ then: DocItemSchema,
149
+ },
150
+ {
151
+ is: itemWithType('docSidebar'),
152
+ then: DocSidebarItemSchema,
153
+ },
154
+ {
155
+ is: itemWithType(undefined),
156
+ then: DefaultNavbarItemSchema,
157
+ },
158
+ {
159
+ is: itemWithType('html'),
160
+ then: HtmlNavbarItemSchema,
161
+ },
162
+ {
163
+ is: itemWithType(CustomNavbarItemRegexp),
164
+ then: CustomNavbarItemSchema,
165
+ },
166
+ {
167
+ is: Joi.alternatives().try(
168
+ itemWithType('dropdown'),
169
+ itemWithType('docsVersionDropdown'),
170
+ itemWithType('localeDropdown'),
171
+ itemWithType('search'),
172
+ ),
173
+ then: Joi.forbidden().messages({
174
+ 'any.unknown': 'Nested dropdowns are not allowed',
175
+ }),
176
+ },
177
+ ],
178
+ otherwise: Joi.forbidden().messages({
179
+ 'any.unknown': 'Bad navbar item type {.type}',
180
+ }),
181
+ });
182
+
183
+ const DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
184
+ items: Joi.array().items(DropdownSubitemSchema).required(),
185
+ });
186
+
187
+ const DocsVersionDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
188
+ type: Joi.string().equal('docsVersionDropdown').required(),
189
+ docsPluginId: Joi.string(),
190
+ dropdownActiveClassDisabled: Joi.boolean(),
191
+ dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
192
+ dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
193
+ });
194
+
195
+ const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
196
+ type: Joi.string().equal('localeDropdown').required(),
197
+ dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
198
+ dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
199
+ });
200
+
201
+ const SearchItemSchema = Joi.object({
202
+ type: Joi.string().equal('search').required(),
203
+ className: Joi.string(),
204
+ });
205
+
206
+ const NavbarItemSchema = Joi.object({
207
+ position: NavbarItemPosition,
208
+ }).when('.', {
209
+ switch: [
210
+ {
211
+ is: itemWithType('docsVersion'),
212
+ then: DocsVersionNavbarItemSchema,
213
+ },
214
+ {
215
+ is: itemWithType('dropdown'),
216
+ then: DropdownNavbarItemSchema,
217
+ },
218
+ {
219
+ is: itemWithType('docsVersionDropdown'),
220
+ then: DocsVersionDropdownNavbarItemSchema,
221
+ },
222
+ {
223
+ is: itemWithType('doc'),
224
+ then: DocItemSchema,
225
+ },
226
+ {
227
+ is: itemWithType('docSidebar'),
228
+ then: DocSidebarItemSchema,
229
+ },
230
+ {
231
+ is: itemWithType('localeDropdown'),
232
+ then: LocaleDropdownNavbarItemSchema,
233
+ },
234
+ {
235
+ is: itemWithType('search'),
236
+ then: SearchItemSchema,
237
+ },
238
+ {
239
+ is: itemWithType('html'),
240
+ then: HtmlNavbarItemSchema,
241
+ },
242
+ {
243
+ is: itemWithType(CustomNavbarItemRegexp),
244
+ then: CustomNavbarItemSchema,
245
+ },
246
+ {
247
+ is: itemWithType(undefined),
248
+ then: Joi.object().when('.', {
249
+ // Dropdown item can be specified without type field
250
+ is: Joi.object({
251
+ items: Joi.array().required(),
252
+ }).unknown(),
253
+ then: DropdownNavbarItemSchema,
254
+ otherwise: DefaultNavbarItemSchema,
255
+ }),
256
+ },
257
+ ],
258
+ otherwise: Joi.forbidden().messages({
259
+ 'any.unknown': 'Bad navbar item type {.type}',
260
+ }),
261
+ });
262
+
263
+ const ColorModeSchema = Joi.object({
264
+ defaultMode: Joi.string()
265
+ .equal('dark', 'light')
266
+ .default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
267
+ disableSwitch: Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
268
+ respectPrefersColorScheme: Joi.bool().default(
269
+ DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme,
270
+ ),
271
+ switchConfig: Joi.any().forbidden().messages({
272
+ 'any.unknown':
273
+ 'colorMode.switchConfig is deprecated. If you want to customize the icons for light and dark mode, swizzle IconLightMode, IconDarkMode, or ColorModeToggle instead.',
274
+ }),
275
+ }).default(DEFAULT_COLOR_MODE_CONFIG);
276
+
277
+ const HtmlMetadataSchema = Joi.object({
278
+ id: Joi.string(),
279
+ name: Joi.string(),
280
+ property: Joi.string(),
281
+ content: Joi.string(),
282
+ itemprop: Joi.string(),
283
+ }).unknown();
284
+
285
+ const FooterLinkItemSchema = Joi.object({
286
+ to: Joi.string(),
287
+ href: URISchema,
288
+ html: Joi.string(),
289
+ label: Joi.string(),
290
+ })
291
+ .xor('to', 'href', 'html')
292
+ .with('to', 'label')
293
+ .with('href', 'label')
294
+ .nand('html', 'label')
295
+ // We allow any unknown attributes on the links (users may need additional
296
+ // attributes like target, aria-role, data-customAttribute...)
297
+ .unknown();
298
+
299
+ const CustomCssSchema = Joi.alternatives()
300
+ .try(Joi.array().items(Joi.string().required()), Joi.string().required())
301
+ .optional();
302
+
303
+ const LogoSchema = Joi.object({
304
+ alt: Joi.string().allow(''),
305
+ src: Joi.string().required(),
306
+ srcDark: Joi.string(),
307
+ width: Joi.alternatives().try(Joi.string(), Joi.number()),
308
+ height: Joi.alternatives().try(Joi.string(), Joi.number()),
309
+ href: Joi.string(),
310
+ target: Joi.string(),
311
+ style: Joi.object(),
312
+ className: Joi.string(),
313
+ });
314
+
315
+ export const ThemeConfigSchema = Joi.object<ThemeConfig>({
316
+ // TODO temporary (@alpha-58)
317
+ // @ts-expect-error: forbidden
318
+ disableDarkMode: Joi.any().forbidden().messages({
319
+ 'any.unknown':
320
+ 'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
321
+ }),
322
+ // TODO temporary (@alpha-58)
323
+ defaultDarkMode: Joi.any().forbidden().messages({
324
+ 'any.unknown':
325
+ 'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
326
+ }),
327
+ customCss: CustomCssSchema,
328
+ colorMode: ColorModeSchema,
329
+ image: Joi.string(),
330
+ docs: DocsSchema,
331
+ metadata: Joi.array()
332
+ .items(HtmlMetadataSchema)
333
+ .default(DEFAULT_CONFIG.metadata),
334
+ // cSpell:ignore metadatas
335
+ metadatas: Joi.any().forbidden().messages({
336
+ 'any.unknown':
337
+ // cSpell:ignore metadatas
338
+ 'themeConfig.metadatas has been renamed as themeConfig.metadata. See https://github.com/facebook/docusaurus/pull/5871',
339
+ }),
340
+ announcementBar: Joi.object({
341
+ id: Joi.string().default('announcement-bar'),
342
+ content: Joi.string().required(),
343
+ backgroundColor: Joi.string(),
344
+ textColor: Joi.string(),
345
+ isCloseable: Joi.bool().default(true),
346
+ }).optional(),
347
+ navbar: Joi.object({
348
+ style: Joi.string().equal('dark', 'primary'),
349
+ hideOnScroll: Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
350
+ // TODO temporary (@alpha-58)
351
+ links: Joi.any().forbidden().messages({
352
+ 'any.unknown':
353
+ 'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
354
+ }),
355
+ items: Joi.array()
356
+ .items(NavbarItemSchema)
357
+ .default(DEFAULT_CONFIG.navbar.items),
358
+ title: Joi.string().allow('', null),
359
+ logo: LogoSchema,
360
+ }).default(DEFAULT_CONFIG.navbar),
361
+ footer: Joi.object({
362
+ style: Joi.string().equal('dark', 'light').default('light'),
363
+ logo: LogoSchema,
364
+ copyright: Joi.string(),
365
+ links: Joi.alternatives(
366
+ Joi.array().items(
367
+ Joi.object({
368
+ title: Joi.string().allow(null).default(null),
369
+ items: Joi.array().items(FooterLinkItemSchema).default([]),
370
+ }),
371
+ ),
372
+ Joi.array().items(FooterLinkItemSchema),
373
+ )
374
+ .messages({
375
+ '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`,
376
+ })
377
+ .default([]),
378
+ }).optional(),
379
+ prism: Joi.object({
380
+ theme: Joi.object({
381
+ plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
382
+ styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
383
+ }).default(DEFAULT_CONFIG.prism.theme),
384
+ darkTheme: Joi.object({
385
+ plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
386
+ styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
387
+ }),
388
+ defaultLanguage: Joi.string(),
389
+ additionalLanguages: Joi.array()
390
+ .items(Joi.string())
391
+ .default(DEFAULT_CONFIG.prism.additionalLanguages),
392
+ magicComments: Joi.array()
393
+ .items(
394
+ Joi.object({
395
+ className: Joi.string().required(),
396
+ line: Joi.string(),
397
+ block: Joi.object({
398
+ start: Joi.string().required(),
399
+ end: Joi.string().required(),
400
+ }),
401
+ }).or('line', 'block'),
402
+ )
403
+ .default(DEFAULT_CONFIG.prism.magicComments),
404
+ })
405
+ .default(DEFAULT_CONFIG.prism)
406
+ .unknown(),
407
+ hideableSidebar: Joi.forbidden().messages({
408
+ 'any.unknown':
409
+ 'themeConfig.hideableSidebar has been moved to themeConfig.docs.sidebar.hideable.',
410
+ }),
411
+ autoCollapseSidebarCategories: Joi.forbidden().messages({
412
+ 'any.unknown':
413
+ 'themeConfig.autoCollapseSidebarCategories has been moved to themeConfig.docs.sidebar.autoCollapseCategories.',
414
+ }),
415
+ sidebarCollapsible: Joi.forbidden().messages({
416
+ 'any.unknown':
417
+ 'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs',
418
+ }),
419
+ tableOfContents: Joi.object({
420
+ minHeadingLevel: Joi.number()
421
+ .default(DEFAULT_CONFIG.tableOfContents.minHeadingLevel)
422
+ .when('maxHeadingLevel', {
423
+ is: Joi.exist(),
424
+ then: Joi.number()
425
+ .integer()
426
+ .min(2)
427
+ .max(6)
428
+ .max(Joi.ref('maxHeadingLevel')),
429
+ otherwise: Joi.number().integer().min(2).max(6),
430
+ }),
431
+ maxHeadingLevel: Joi.number()
432
+ .integer()
433
+ .min(2)
434
+ .max(6)
435
+ .default(DEFAULT_CONFIG.tableOfContents.maxHeadingLevel),
436
+ }).default(DEFAULT_CONFIG.tableOfContents),
437
+ });
438
+
439
+ export function validateThemeConfig({
440
+ validate,
441
+ themeConfig,
442
+ }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig {
443
+ return validate(ThemeConfigSchema, themeConfig);
444
+ }
package/babel.config.js DELETED
@@ -1,35 +0,0 @@
1
- /**
2
- * Copyright (c) Facebook, Inc. and its affiliates.
3
- *
4
- * This source code is licensed under the MIT license found in the
5
- * LICENSE file in the root directory of this source tree.
6
- */
7
-
8
- module.exports = {
9
- env: {
10
- // USED FOR NODE/RUNTIME
11
- // maybe we should differenciate both cases because
12
- // we mostly need to transpile some features so that node does not crash...
13
- lib: {
14
- presets: [
15
- ['@babel/preset-typescript', {isTSX: true, allExtensions: true}],
16
- ],
17
- // Useful to transpile for older node versions
18
- plugins: [
19
- '@babel/plugin-transform-modules-commonjs',
20
- '@babel/plugin-proposal-nullish-coalescing-operator',
21
- '@babel/plugin-proposal-optional-chaining',
22
- ],
23
- },
24
-
25
- // USED FOR JS SWIZZLE
26
- // /lib-next folder is used as source to swizzle JS source code
27
- // This JS code is created from TS source code
28
- // This source code should look clean/human readable to be usable
29
- 'lib-next': {
30
- presets: [
31
- ['@babel/preset-typescript', {isTSX: true, allExtensions: true}],
32
- ],
33
- },
34
- },
35
- };