@docusaurus/theme-classic 2.0.0-beta.fc64c12e4 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (748) 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 +107 -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/options.d.ts +14 -0
  10. package/lib/options.js +409 -0
  11. package/lib/prism-include-languages.d.ts +7 -0
  12. package/lib/prism-include-languages.js +0 -2
  13. package/lib/theme/Admonition/index.d.ts +9 -0
  14. package/lib/theme/Admonition/index.js +183 -0
  15. package/lib/{admonitions.css → theme/Admonition/styles.module.css} +17 -14
  16. package/lib/theme/AnnouncementBar/index.d.ts +8 -0
  17. package/lib/theme/AnnouncementBar/index.js +39 -63
  18. package/lib/theme/AnnouncementBar/styles.module.css +23 -32
  19. package/lib/theme/BackToTopButton/index.d.ts +8 -0
  20. package/lib/theme/BackToTopButton/index.js +25 -121
  21. package/lib/theme/BackToTopButton/styles.module.css +20 -15
  22. package/lib/theme/BlogArchivePage/index.d.ts +10 -0
  23. package/lib/theme/BlogArchivePage/index.js +80 -0
  24. package/lib/theme/BlogLayout/index.d.ts +9 -0
  25. package/lib/theme/BlogLayout/index.js +19 -41
  26. package/lib/theme/BlogListPage/index.d.ts +10 -0
  27. package/lib/theme/BlogListPage/index.js +44 -50
  28. package/lib/theme/BlogListPaginator/index.d.ts +9 -0
  29. package/lib/theme/BlogListPaginator/index.js +41 -56
  30. package/lib/theme/BlogPostItem/Container/index.d.ts +9 -0
  31. package/lib/theme/BlogPostItem/Container/index.js +26 -0
  32. package/lib/theme/BlogPostItem/Content/index.d.ts +9 -0
  33. package/lib/theme/BlogPostItem/Content/index.js +23 -0
  34. package/lib/theme/BlogPostItem/Footer/ReadMoreLink/index.d.ts +9 -0
  35. package/lib/theme/BlogPostItem/Footer/ReadMoreLink/index.js +38 -0
  36. package/lib/theme/BlogPostItem/Footer/index.d.ts +8 -0
  37. package/lib/theme/BlogPostItem/Footer/index.js +52 -0
  38. package/{src/theme/IconEdit → lib/theme/BlogPostItem/Footer}/styles.module.css +2 -3
  39. package/lib/theme/BlogPostItem/Header/Author/index.d.ts +9 -0
  40. package/lib/theme/BlogPostItem/Header/Author/index.js +47 -0
  41. package/lib/theme/BlogPostItem/Header/Authors/index.d.ts +9 -0
  42. package/lib/theme/BlogPostItem/Header/Authors/index.js +48 -0
  43. package/{lib-next/theme/Toggle → lib/theme/BlogPostItem/Header/Authors}/styles.module.css +11 -7
  44. package/lib/theme/BlogPostItem/Header/Info/index.d.ts +9 -0
  45. package/lib/theme/BlogPostItem/Header/Info/index.js +60 -0
  46. package/{lib-next/theme/MDXPage → lib/theme/BlogPostItem/Header/Info}/styles.module.css +2 -2
  47. package/lib/theme/BlogPostItem/Header/Title/index.d.ts +9 -0
  48. package/lib/theme/BlogPostItem/Header/Title/index.js +27 -0
  49. package/{src/theme/BlogPostItem → lib/theme/BlogPostItem/Header/Title}/styles.module.css +8 -7
  50. package/lib/theme/BlogPostItem/Header/index.d.ts +8 -0
  51. package/lib/theme/BlogPostItem/Header/index.js +19 -0
  52. package/{lib-next/theme/Footer/styles.module.css → lib/theme/BlogPostItem/index.d.ts} +3 -9
  53. package/lib/theme/BlogPostItem/index.js +20 -153
  54. package/lib/theme/BlogPostItems/index.d.ts +9 -0
  55. package/lib/theme/BlogPostItems/index.js +27 -0
  56. package/lib/theme/BlogPostPage/Metadata/index.d.ts +8 -0
  57. package/lib/theme/BlogPostPage/Metadata/index.js +41 -0
  58. package/lib/theme/BlogPostPage/index.d.ts +10 -0
  59. package/lib/theme/BlogPostPage/index.js +51 -44
  60. package/lib/theme/BlogPostPaginator/index.d.ts +9 -0
  61. package/lib/theme/BlogPostPaginator/index.js +40 -57
  62. package/lib/theme/BlogSidebar/Desktop/index.d.ts +9 -0
  63. package/{lib-next/theme/BlogSidebar → lib/theme/BlogSidebar/Desktop}/index.js +19 -23
  64. package/{lib-next/theme/BlogSidebar → lib/theme/BlogSidebar/Desktop}/styles.module.css +5 -4
  65. package/lib/theme/BlogSidebar/Mobile/index.d.ts +9 -0
  66. package/lib/theme/BlogSidebar/Mobile/index.js +34 -0
  67. package/lib/theme/BlogSidebar/index.d.ts +9 -0
  68. package/lib/theme/BlogSidebar/index.js +13 -43
  69. package/lib/theme/BlogTagsListPage/index.d.ts +10 -0
  70. package/lib/theme/BlogTagsListPage/index.js +27 -58
  71. package/lib/theme/BlogTagsPostsPage/index.d.ts +10 -0
  72. package/lib/theme/BlogTagsPostsPage/index.js +73 -73
  73. package/lib/theme/CodeBlock/Container/index.d.ts +10 -0
  74. package/lib/theme/CodeBlock/Container/index.js +27 -0
  75. package/lib/theme/CodeBlock/Container/styles.module.css +14 -0
  76. package/lib/theme/CodeBlock/Content/Element.d.ts +9 -0
  77. package/lib/theme/CodeBlock/Content/Element.js +23 -0
  78. package/lib/theme/CodeBlock/Content/String.d.ts +9 -0
  79. package/lib/theme/CodeBlock/Content/String.js +103 -0
  80. package/lib/theme/CodeBlock/{styles.module.css → Content/styles.module.css} +46 -26
  81. package/lib/theme/CodeBlock/CopyButton/index.d.ts +9 -0
  82. package/lib/theme/CodeBlock/CopyButton/index.js +62 -0
  83. package/lib/theme/CodeBlock/CopyButton/styles.module.css +47 -0
  84. package/lib/theme/CodeBlock/Line/index.d.ts +9 -0
  85. package/lib/theme/CodeBlock/Line/index.js +42 -0
  86. package/lib/theme/CodeBlock/Line/styles.module.css +51 -0
  87. package/lib/theme/CodeBlock/WordWrapButton/index.d.ts +9 -0
  88. package/lib/theme/CodeBlock/WordWrapButton/index.js +40 -0
  89. package/lib/theme/{BlogPostItem → CodeBlock/WordWrapButton}/styles.module.css +5 -8
  90. package/lib/theme/CodeBlock/index.d.ts +9 -0
  91. package/lib/theme/CodeBlock/index.js +31 -244
  92. package/lib/theme/ColorModeToggle/index.d.ts +11 -0
  93. package/lib/theme/ColorModeToggle/index.js +60 -0
  94. package/lib/theme/ColorModeToggle/styles.module.css +35 -0
  95. package/lib/theme/Details/index.d.ts +9 -0
  96. package/lib/theme/Details/index.js +14 -23
  97. package/lib/theme/DocBreadcrumbs/index.d.ts +8 -0
  98. package/lib/theme/DocBreadcrumbs/index.js +115 -0
  99. package/{src/theme/IconExternalLink → lib/theme/DocBreadcrumbs}/styles.module.css +9 -2
  100. package/lib/theme/DocCard/index.d.ts +9 -0
  101. package/lib/theme/DocCard/index.js +86 -0
  102. package/lib/theme/DocCard/styles.module.css +34 -0
  103. package/lib/theme/DocCardList/index.d.ts +9 -0
  104. package/lib/theme/DocCardList/index.js +30 -0
  105. package/lib/theme/DocCategoryGeneratedIndexPage/index.d.ts +10 -0
  106. package/lib/theme/DocCategoryGeneratedIndexPage/index.js +65 -0
  107. package/lib/theme/DocCategoryGeneratedIndexPage/styles.module.css +26 -0
  108. package/lib/theme/DocItem/Content/index.d.ts +9 -0
  109. package/lib/theme/DocItem/Content/index.js +44 -0
  110. package/lib/theme/DocItem/Footer/index.d.ts +8 -0
  111. package/lib/theme/DocItem/Footer/index.js +74 -0
  112. package/{src/theme/DocSidebarItem → lib/theme/DocItem/Footer}/styles.module.css +8 -5
  113. package/lib/theme/DocItem/Layout/index.d.ts +9 -0
  114. package/lib/theme/DocItem/Layout/index.js +59 -0
  115. package/lib/theme/DocItem/Layout/styles.module.css +17 -0
  116. package/lib/theme/DocItem/Metadata/index.d.ts +8 -0
  117. package/lib/theme/DocItem/Metadata/index.js +20 -0
  118. package/lib/theme/DocItem/Paginator/index.d.ts +12 -0
  119. package/lib/theme/DocItem/Paginator/index.js +17 -0
  120. package/lib/theme/DocItem/TOC/Desktop/index.d.ts +8 -0
  121. package/lib/theme/DocItem/TOC/Desktop/index.js +21 -0
  122. package/lib/theme/DocItem/TOC/Mobile/index.d.ts +8 -0
  123. package/lib/theme/DocItem/TOC/Mobile/index.js +23 -0
  124. package/lib/theme/DocItem/{styles.module.css → TOC/Mobile/styles.module.css} +6 -19
  125. package/lib/theme/DocItem/index.d.ts +10 -0
  126. package/lib/theme/DocItem/index.js +18 -131
  127. package/lib/theme/DocPage/Layout/Main/index.d.ts +9 -0
  128. package/lib/theme/DocPage/Layout/Main/index.js +29 -0
  129. package/lib/theme/DocPage/Layout/Main/styles.module.css +28 -0
  130. package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/index.d.ts +9 -0
  131. package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/index.js +34 -0
  132. package/lib/theme/DocPage/Layout/Sidebar/ExpandButton/styles.module.css +33 -0
  133. package/lib/theme/DocPage/Layout/Sidebar/index.d.ts +9 -0
  134. package/lib/theme/DocPage/Layout/Sidebar/index.js +66 -0
  135. package/lib/theme/DocPage/Layout/Sidebar/styles.module.css +32 -0
  136. package/lib/theme/DocPage/Layout/index.d.ts +9 -0
  137. package/lib/theme/DocPage/Layout/index.js +34 -0
  138. package/lib/theme/DocPage/Layout/styles.module.css +15 -0
  139. package/lib/theme/DocPage/index.d.ts +10 -0
  140. package/lib/theme/DocPage/index.js +42 -134
  141. package/lib/theme/DocPaginator/index.d.ts +9 -0
  142. package/lib/theme/DocPaginator/index.js +40 -56
  143. package/lib/theme/DocSidebar/Desktop/CollapseButton/index.d.ts +9 -0
  144. package/lib/theme/DocSidebar/Desktop/CollapseButton/index.js +34 -0
  145. package/lib/theme/DocSidebar/Desktop/CollapseButton/styles.module.css +46 -0
  146. package/lib/theme/DocSidebar/Desktop/Content/index.d.ts +9 -0
  147. package/lib/theme/DocSidebar/Desktop/Content/index.js +44 -0
  148. package/lib/theme/DocSidebar/Desktop/Content/styles.module.css +23 -0
  149. package/lib/theme/DocSidebar/Desktop/index.d.ts +11 -0
  150. package/lib/theme/DocSidebar/Desktop/index.js +34 -0
  151. package/lib/theme/DocSidebar/Desktop/styles.module.css +50 -0
  152. package/lib/theme/DocSidebar/Mobile/index.d.ts +11 -0
  153. package/lib/theme/DocSidebar/Mobile/index.js +45 -0
  154. package/lib/theme/DocSidebar/index.d.ts +9 -0
  155. package/lib/theme/DocSidebar/index.js +17 -124
  156. package/lib/theme/DocSidebarItem/Category/index.d.ts +9 -0
  157. package/lib/theme/DocSidebarItem/Category/index.js +185 -0
  158. package/lib/theme/DocSidebarItem/Html/index.d.ts +9 -0
  159. package/lib/theme/DocSidebarItem/Html/index.js +26 -0
  160. package/{lib-next/theme/DocSidebarItem → lib/theme/DocSidebarItem/Html}/styles.module.css +3 -5
  161. package/lib/theme/DocSidebarItem/Link/index.d.ts +9 -0
  162. package/lib/theme/DocSidebarItem/Link/index.js +54 -0
  163. package/lib/theme/DocSidebarItem/Link/styles.module.css +10 -0
  164. package/lib/theme/DocSidebarItem/index.d.ts +9 -0
  165. package/lib/theme/DocSidebarItem/index.js +7 -161
  166. package/lib/theme/DocSidebarItems/index.d.ts +11 -0
  167. package/lib/theme/DocSidebarItems/index.js +22 -0
  168. package/lib/theme/DocTagDocListPage/index.d.ts +10 -0
  169. package/lib/theme/DocTagDocListPage/index.js +89 -0
  170. package/lib/theme/DocTagsListPage/index.d.ts +10 -0
  171. package/lib/theme/DocTagsListPage/index.js +40 -0
  172. package/lib/theme/DocVersionBadge/index.d.ts +9 -0
  173. package/lib/theme/DocVersionBadge/index.js +31 -0
  174. package/lib/theme/DocVersionBanner/index.d.ts +9 -0
  175. package/lib/theme/DocVersionBanner/index.js +105 -102
  176. package/lib/theme/EditThisPage/index.d.ts +9 -0
  177. package/lib/theme/EditThisPage/index.js +19 -24
  178. package/{src/theme/hooks/useLockBodyScroll.ts → lib/theme/ErrorPageContent.d.ts} +4 -14
  179. package/lib/theme/ErrorPageContent.js +35 -0
  180. package/lib/theme/Footer/Copyright/index.d.ts +9 -0
  181. package/lib/theme/Footer/Copyright/index.js +17 -0
  182. package/lib/theme/Footer/Layout/index.d.ts +9 -0
  183. package/lib/theme/Footer/Layout/index.js +26 -0
  184. package/lib/theme/Footer/LinkItem/index.d.ts +9 -0
  185. package/lib/theme/Footer/LinkItem/index.js +31 -0
  186. package/lib/theme/Footer/Links/MultiColumn/index.d.ts +9 -0
  187. package/lib/theme/Footer/Links/MultiColumn/index.js +43 -0
  188. package/lib/theme/Footer/Links/Simple/index.d.ts +9 -0
  189. package/lib/theme/Footer/Links/Simple/index.js +37 -0
  190. package/lib/theme/Footer/Links/index.d.ts +9 -0
  191. package/lib/theme/Footer/Links/index.js +17 -0
  192. package/lib/theme/Footer/Logo/index.d.ts +9 -0
  193. package/lib/theme/Footer/Logo/index.js +41 -0
  194. package/{src/theme/Footer → lib/theme/Footer/Logo}/styles.module.css +2 -1
  195. package/lib/theme/Footer/index.d.ts +10 -0
  196. package/lib/theme/Footer/index.js +17 -104
  197. package/lib/theme/Heading/index.d.ts +9 -0
  198. package/lib/theme/Heading/index.js +35 -68
  199. package/lib/theme/Heading/styles.module.css +25 -5
  200. package/lib/theme/Icon/Arrow/index.d.ts +9 -0
  201. package/{lib-next/theme/IconArrow → lib/theme/Icon/Arrow}/index.js +2 -5
  202. package/lib/theme/Icon/Close/index.d.ts +9 -0
  203. package/lib/theme/Icon/Close/index.js +23 -0
  204. package/lib/theme/Icon/DarkMode/index.d.ts +9 -0
  205. package/lib/theme/Icon/DarkMode/index.js +17 -0
  206. package/lib/theme/Icon/Edit/index.d.ts +9 -0
  207. package/{lib-next/theme/IconEdit → lib/theme/Icon/Edit}/index.js +2 -5
  208. package/{lib-next/theme/IconEdit → lib/theme/Icon/Edit}/styles.module.css +0 -0
  209. package/lib/theme/Icon/ExternalLink/index.d.ts +9 -0
  210. package/{lib-next/theme/IconExternalLink → lib/theme/Icon/ExternalLink}/index.js +2 -5
  211. package/{lib-next/theme/IconExternalLink → lib/theme/Icon/ExternalLink}/styles.module.css +0 -2
  212. package/lib/theme/Icon/Home/index.d.ts +9 -0
  213. package/lib/theme/Icon/Home/index.js +17 -0
  214. package/lib/theme/Icon/Language/index.d.ts +9 -0
  215. package/lib/theme/Icon/Language/index.js +22 -0
  216. package/lib/theme/Icon/LightMode/index.d.ts +9 -0
  217. package/lib/theme/Icon/LightMode/index.js +17 -0
  218. package/lib/theme/Icon/Menu/index.d.ts +9 -0
  219. package/{lib-next/theme/IconMenu → lib/theme/Icon/Menu}/index.js +7 -5
  220. package/lib/theme/LastUpdated/index.d.ts +9 -0
  221. package/lib/theme/LastUpdated/index.js +57 -42
  222. package/lib/theme/Layout/Provider/index.d.ts +9 -0
  223. package/lib/theme/Layout/Provider/index.js +29 -0
  224. package/lib/theme/Layout/index.d.ts +9 -0
  225. package/lib/theme/Layout/index.js +39 -50
  226. package/{lib-next/theme/Layout/styles.css → lib/theme/Layout/styles.module.css} +9 -10
  227. package/lib/theme/Logo/index.d.ts +9 -0
  228. package/lib/theme/Logo/index.js +57 -51
  229. package/lib/theme/MDXComponents/A.d.ts +9 -0
  230. package/{lib-next/theme/ThemeContext.js → lib/theme/MDXComponents/A.js} +4 -2
  231. package/lib/theme/MDXComponents/Code.d.ts +9 -0
  232. package/lib/theme/MDXComponents/Code.js +28 -0
  233. package/lib/theme/MDXComponents/Details.d.ts +9 -0
  234. package/lib/theme/MDXComponents/Details.js +22 -0
  235. package/lib/theme/MDXComponents/Head.d.ts +9 -0
  236. package/lib/theme/MDXComponents/Head.js +23 -0
  237. package/lib/theme/MDXComponents/Heading.d.ts +9 -0
  238. package/{lib-next/theme/NavbarItem/SearchNavbarItem.js → lib/theme/MDXComponents/Heading.js} +3 -7
  239. package/lib/theme/MDXComponents/Img/index.d.ts +9 -0
  240. package/lib/theme/MDXComponents/Img/index.js +22 -0
  241. package/lib/theme/MDXComponents/Img/styles.module.css +10 -0
  242. package/lib/theme/MDXComponents/Pre.d.ts +9 -0
  243. package/lib/theme/MDXComponents/Pre.js +19 -0
  244. package/lib/theme/MDXComponents/Ul/index.d.ts +9 -0
  245. package/lib/theme/MDXComponents/Ul/index.js +21 -0
  246. package/lib/theme/MDXComponents/Ul/styles.module.css +14 -0
  247. package/lib/theme/MDXComponents/index.d.ts +9 -0
  248. package/lib/theme/MDXComponents/index.js +25 -72
  249. package/lib/theme/MDXContent/index.d.ts +9 -0
  250. package/lib/theme/MDXContent/index.js +12 -0
  251. package/lib/theme/MDXPage/index.d.ts +10 -0
  252. package/lib/theme/MDXPage/index.js +46 -56
  253. package/lib/theme/Navbar/ColorModeToggle/index.d.ts +9 -0
  254. package/lib/theme/Navbar/ColorModeToggle/index.js +23 -0
  255. package/lib/theme/Navbar/Content/index.d.ts +8 -0
  256. package/lib/theme/Navbar/Content/index.js +71 -0
  257. package/lib/theme/Navbar/Content/styles.module.css +15 -0
  258. package/lib/theme/Navbar/Layout/index.d.ts +9 -0
  259. package/lib/theme/Navbar/Layout/index.js +52 -0
  260. package/{lib-next/theme/Navbar → lib/theme/Navbar/Layout}/styles.module.css +0 -9
  261. package/lib/theme/Navbar/Logo/index.d.ts +8 -0
  262. package/{lib-next/theme/TabItem → lib/theme/Navbar/Logo}/index.js +7 -12
  263. package/lib/theme/Navbar/MobileSidebar/Header/index.d.ts +8 -0
  264. package/lib/theme/Navbar/MobileSidebar/Header/index.js +31 -0
  265. package/lib/theme/Navbar/MobileSidebar/Layout/index.d.ts +9 -0
  266. package/lib/theme/Navbar/MobileSidebar/Layout/index.js +28 -0
  267. package/{lib-next/theme/TOCInline/styles.module.css → lib/theme/Navbar/MobileSidebar/PrimaryMenu/index.d.ts} +2 -6
  268. package/lib/theme/Navbar/MobileSidebar/PrimaryMenu/index.js +33 -0
  269. package/lib/theme/Navbar/MobileSidebar/SecondaryMenu/index.d.ts +8 -0
  270. package/lib/theme/Navbar/MobileSidebar/SecondaryMenu/index.js +36 -0
  271. package/lib/theme/Navbar/MobileSidebar/Toggle/index.d.ts +8 -0
  272. package/lib/theme/Navbar/MobileSidebar/Toggle/index.js +23 -0
  273. package/lib/theme/Navbar/MobileSidebar/index.d.ts +8 -0
  274. package/lib/theme/Navbar/MobileSidebar/index.js +29 -0
  275. package/lib/theme/Navbar/Search/index.d.ts +9 -0
  276. package/lib/theme/Navbar/Search/index.js +12 -0
  277. package/lib/theme/Navbar/Search/styles.module.css +20 -0
  278. package/{lib-next/theme/hooks/styles.css → lib/theme/Navbar/index.d.ts} +2 -4
  279. package/lib/theme/Navbar/index.js +9 -242
  280. package/lib/theme/NavbarItem/ComponentTypes.d.ts +9 -0
  281. package/lib/theme/NavbarItem/ComponentTypes.js +27 -0
  282. package/lib/theme/NavbarItem/DefaultNavbarItem.d.ts +10 -0
  283. package/lib/theme/NavbarItem/DefaultNavbarItem.js +30 -83
  284. package/lib/theme/NavbarItem/DocNavbarItem.d.ts +9 -0
  285. package/lib/theme/NavbarItem/DocNavbarItem.js +24 -51
  286. package/lib/theme/NavbarItem/DocSidebarNavbarItem.d.ts +9 -0
  287. package/lib/theme/NavbarItem/DocSidebarNavbarItem.js +33 -0
  288. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.d.ts +9 -0
  289. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +71 -61
  290. package/lib/theme/NavbarItem/DocsVersionNavbarItem.d.ts +9 -0
  291. package/lib/theme/NavbarItem/DocsVersionNavbarItem.js +11 -32
  292. package/lib/theme/NavbarItem/DropdownNavbarItem.d.ts +9 -0
  293. package/lib/theme/NavbarItem/DropdownNavbarItem.js +109 -103
  294. package/lib/theme/NavbarItem/HtmlNavbarItem.d.ts +9 -0
  295. package/lib/theme/NavbarItem/HtmlNavbarItem.js +28 -0
  296. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/index.d.ts +9 -0
  297. package/{src/theme/NavbarItem/LocaleDropdownNavbarItem.tsx → lib/theme/NavbarItem/LocaleDropdownNavbarItem/index.js} +28 -27
  298. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  299. package/lib/theme/NavbarItem/NavbarNavLink.d.ts +9 -0
  300. package/lib/theme/NavbarItem/NavbarNavLink.js +68 -0
  301. package/lib/theme/NavbarItem/SearchNavbarItem.d.ts +9 -0
  302. package/lib/theme/NavbarItem/SearchNavbarItem.js +10 -19
  303. package/lib/theme/NavbarItem/index.d.ts +9 -0
  304. package/lib/theme/NavbarItem/index.js +11 -56
  305. package/lib/theme/NotFound.d.ts +8 -0
  306. package/lib/theme/NotFound.js +44 -49
  307. package/lib/theme/PaginatorNavLink/index.d.ts +9 -0
  308. package/lib/theme/PaginatorNavLink/index.js +23 -0
  309. package/lib/theme/SearchBar.d.ts +7 -0
  310. package/lib/theme/SearchBar.js +11 -15
  311. package/lib/theme/SearchMetadata/index.d.ts +9 -0
  312. package/lib/theme/SearchMetadata/index.js +34 -0
  313. package/lib/theme/SiteMetadata/index.d.ts +8 -0
  314. package/lib/theme/SiteMetadata/index.js +116 -0
  315. package/lib/theme/SkipToContent/index.d.ts +8 -0
  316. package/lib/theme/SkipToContent/index.js +16 -62
  317. package/lib/theme/SkipToContent/styles.module.css +7 -0
  318. package/lib/theme/TOC/index.d.ts +9 -0
  319. package/lib/theme/TOC/index.js +18 -53
  320. package/lib/theme/TOC/styles.module.css +1 -1
  321. package/lib/theme/TOCCollapsible/CollapseButton/index.d.ts +9 -0
  322. package/lib/theme/TOCCollapsible/CollapseButton/index.js +29 -0
  323. package/{lib-next/theme/TOCCollapsible → lib/theme/TOCCollapsible/CollapseButton}/styles.module.css +2 -23
  324. package/lib/theme/TOCCollapsible/index.d.ts +9 -0
  325. package/lib/theme/TOCCollapsible/index.js +33 -42
  326. package/lib/theme/TOCCollapsible/styles.module.css +1 -20
  327. package/lib/theme/TOCInline/index.d.ts +9 -0
  328. package/lib/theme/TOCInline/index.js +15 -46
  329. package/lib/theme/TOCItems/Tree.d.ts +11 -0
  330. package/lib/theme/TOCItems/Tree.js +37 -0
  331. package/lib/theme/TOCItems/index.d.ts +9 -0
  332. package/lib/theme/TOCItems/index.js +53 -0
  333. package/lib/theme/TabItem/index.d.ts +9 -0
  334. package/lib/theme/TabItem/index.js +11 -24
  335. package/lib/theme/TabItem/styles.module.css +10 -0
  336. package/lib/theme/Tabs/index.d.ts +9 -0
  337. package/lib/theme/Tabs/index.js +159 -123
  338. package/lib/theme/Tabs/styles.module.css +4 -13
  339. package/lib/theme/Tag/index.d.ts +9 -0
  340. package/lib/theme/Tag/index.js +23 -0
  341. package/lib/theme/Tag/styles.module.css +70 -0
  342. package/lib/theme/TagsListByLetter/index.d.ts +9 -0
  343. package/lib/theme/TagsListByLetter/index.js +38 -0
  344. package/lib/theme/TagsListByLetter/styles.module.css +11 -0
  345. package/lib/theme/TagsListInline/index.d.ts +9 -0
  346. package/lib/theme/TagsListInline/index.js +31 -0
  347. package/lib/theme/TagsListInline/styles.module.css +15 -0
  348. package/lib/theme/ThemedImage/index.d.ts +9 -0
  349. package/lib/theme/ThemedImage/index.js +33 -43
  350. package/lib/theme/ThemedImage/styles.module.css +2 -2
  351. package/lib/theme/prism-include-languages.d.ts +8 -0
  352. package/lib/theme/prism-include-languages.js +19 -33
  353. package/lib/translations.d.ts +15 -0
  354. package/lib/translations.js +122 -122
  355. package/package.json +41 -36
  356. package/src/deps.d.ts +13 -0
  357. package/src/getSwizzleConfig.ts +245 -0
  358. package/src/index.ts +53 -79
  359. package/src/nprogress.css +41 -0
  360. package/src/nprogress.ts +31 -0
  361. package/{lib/validateThemeConfig.js → src/options.ts} +204 -72
  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/{admonitions.css → theme/Admonition/styles.module.css} +17 -14
  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 +18 -105
  368. package/src/theme/BackToTopButton/styles.module.css +20 -15
  369. package/src/theme/BlogArchivePage/index.tsx +92 -0
  370. package/src/theme/BlogLayout/index.tsx +6 -16
  371. package/src/theme/BlogListPage/index.tsx +33 -24
  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 +47 -22
  390. package/src/theme/BlogPostPaginator/index.tsx +27 -36
  391. package/src/theme/BlogSidebar/Desktop/index.tsx +45 -0
  392. package/{lib/theme/BlogSidebar → src/theme/BlogSidebar/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 +23 -57
  396. package/src/theme/BlogTagsPostsPage/index.tsx +48 -31
  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/{lib-next/theme/CodeBlock → src/theme/CodeBlock/Content}/styles.module.css +46 -26
  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 -251
  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 +4 -2
  412. package/src/theme/DocBreadcrumbs/index.tsx +141 -0
  413. package/{lib-next/theme/Heading/styles.css → src/theme/DocBreadcrumbs/styles.module.css} +9 -13
  414. package/src/theme/DocCard/index.tsx +120 -0
  415. package/src/theme/DocCard/styles.module.css +34 -0
  416. package/src/theme/DocCardList/index.tsx +35 -0
  417. package/src/theme/DocCategoryGeneratedIndexPage/index.tsx +77 -0
  418. package/src/theme/DocCategoryGeneratedIndexPage/styles.module.css +26 -0
  419. package/src/theme/DocItem/Content/index.tsx +48 -0
  420. package/src/theme/DocItem/Footer/index.tsx +89 -0
  421. package/src/theme/DocItem/Footer/styles.module.css +18 -0
  422. package/src/theme/DocItem/Layout/index.tsx +68 -0
  423. package/src/theme/DocItem/Layout/styles.module.css +17 -0
  424. package/src/theme/DocItem/Metadata/index.tsx +22 -0
  425. package/src/theme/DocItem/Paginator/index.tsx +19 -0
  426. package/src/theme/DocItem/TOC/Desktop/index.tsx +24 -0
  427. package/src/theme/DocItem/TOC/Mobile/index.tsx +27 -0
  428. package/src/theme/DocItem/TOC/Mobile/styles.module.css +19 -0
  429. package/src/theme/DocItem/index.tsx +15 -120
  430. package/src/theme/DocPage/Layout/Main/index.tsx +36 -0
  431. package/src/theme/DocPage/Layout/Main/styles.module.css +28 -0
  432. package/src/theme/DocPage/Layout/Sidebar/ExpandButton/index.tsx +40 -0
  433. package/src/theme/DocPage/Layout/Sidebar/ExpandButton/styles.module.css +33 -0
  434. package/src/theme/DocPage/Layout/Sidebar/index.tsx +74 -0
  435. package/src/theme/DocPage/Layout/Sidebar/styles.module.css +32 -0
  436. package/src/theme/DocPage/Layout/index.tsx +38 -0
  437. package/src/theme/DocPage/Layout/styles.module.css +15 -0
  438. package/src/theme/DocPage/index.tsx +39 -150
  439. package/src/theme/DocPaginator/index.tsx +28 -40
  440. package/src/theme/DocSidebar/Desktop/CollapseButton/index.tsx +38 -0
  441. package/src/theme/DocSidebar/Desktop/CollapseButton/styles.module.css +46 -0
  442. package/src/theme/DocSidebar/Desktop/Content/index.tsx +55 -0
  443. package/src/theme/DocSidebar/Desktop/Content/styles.module.css +23 -0
  444. package/src/theme/DocSidebar/Desktop/index.tsx +40 -0
  445. package/src/theme/DocSidebar/Desktop/styles.module.css +50 -0
  446. package/src/theme/DocSidebar/Mobile/index.tsx +54 -0
  447. package/src/theme/DocSidebar/index.tsx +6 -110
  448. package/src/theme/DocSidebarItem/Category/index.tsx +211 -0
  449. package/src/theme/DocSidebarItem/Html/index.tsx +34 -0
  450. package/{lib/theme/DocSidebarItem → src/theme/DocSidebarItem/Html}/styles.module.css +3 -5
  451. package/src/theme/DocSidebarItem/Link/index.tsx +58 -0
  452. package/src/theme/DocSidebarItem/Link/styles.module.css +10 -0
  453. package/src/theme/DocSidebarItem/index.tsx +7 -167
  454. package/src/theme/DocSidebarItems/index.tsx +27 -0
  455. package/src/theme/DocTagDocListPage/index.tsx +95 -0
  456. package/src/theme/DocTagsListPage/index.tsx +43 -0
  457. package/src/theme/DocVersionBadge/index.tsx +36 -0
  458. package/src/theme/DocVersionBanner/index.tsx +53 -28
  459. package/src/theme/EditThisPage/index.tsx +7 -3
  460. package/src/theme/ErrorPageContent.tsx +41 -0
  461. package/src/theme/Footer/Copyright/index.tsx +20 -0
  462. package/src/theme/Footer/Layout/index.tsx +34 -0
  463. package/src/theme/Footer/LinkItem/index.tsx +36 -0
  464. package/src/theme/Footer/Links/MultiColumn/index.tsx +51 -0
  465. package/src/theme/Footer/Links/Simple/index.tsx +42 -0
  466. package/src/theme/Footer/Links/index.tsx +21 -0
  467. package/src/theme/Footer/Logo/index.tsx +46 -0
  468. package/{lib/theme/Footer → src/theme/Footer/Logo}/styles.module.css +2 -1
  469. package/src/theme/Footer/index.tsx +13 -122
  470. package/src/theme/Heading/index.tsx +31 -58
  471. package/src/theme/Heading/styles.module.css +25 -5
  472. package/src/theme/{IconArrow → Icon/Arrow}/index.tsx +3 -5
  473. package/src/theme/Icon/Close/index.tsx +26 -0
  474. package/src/theme/Icon/DarkMode/index.tsx +20 -0
  475. package/src/theme/{IconEdit → Icon/Edit}/index.tsx +6 -6
  476. package/{lib/theme/IconEdit → src/theme/Icon/Edit}/styles.module.css +0 -0
  477. package/src/theme/{IconExternalLink → Icon/ExternalLink}/index.tsx +4 -6
  478. package/{lib/theme/IconExternalLink → src/theme/Icon/ExternalLink}/styles.module.css +0 -2
  479. package/src/theme/Icon/Home/index.tsx +20 -0
  480. package/src/theme/Icon/Language/index.tsx +29 -0
  481. package/src/theme/Icon/LightMode/index.tsx +20 -0
  482. package/src/theme/{IconMenu → Icon/Menu}/index.tsx +4 -6
  483. package/src/theme/LastUpdated/index.tsx +4 -2
  484. package/src/theme/Layout/Provider/index.tsx +33 -0
  485. package/src/theme/Layout/index.tsx +23 -15
  486. package/src/theme/Layout/{styles.css → styles.module.css} +9 -10
  487. package/src/theme/Logo/index.tsx +57 -26
  488. package/src/theme/{ThemeContext.ts → MDXComponents/A.tsx} +5 -6
  489. package/src/theme/MDXComponents/Code.tsx +40 -0
  490. package/src/theme/MDXComponents/Details.tsx +28 -0
  491. package/src/theme/MDXComponents/Head.tsx +29 -0
  492. package/src/theme/MDXComponents/Heading.tsx +14 -0
  493. package/src/theme/MDXComponents/Img/index.tsx +27 -0
  494. package/src/theme/MDXComponents/Img/styles.module.css +10 -0
  495. package/src/theme/MDXComponents/Pre.tsx +23 -0
  496. package/src/theme/MDXComponents/Ul/index.tsx +26 -0
  497. package/src/theme/MDXComponents/Ul/styles.module.css +14 -0
  498. package/src/theme/MDXComponents/index.tsx +25 -57
  499. package/src/theme/MDXContent/index.tsx +15 -0
  500. package/src/theme/MDXPage/index.tsx +40 -35
  501. package/src/theme/Navbar/ColorModeToggle/index.tsx +30 -0
  502. package/src/theme/Navbar/Content/index.tsx +86 -0
  503. package/src/theme/Navbar/Content/styles.module.css +15 -0
  504. package/src/theme/Navbar/Layout/index.tsx +57 -0
  505. package/src/theme/Navbar/{styles.module.css → Layout/styles.module.css} +0 -9
  506. package/src/theme/Navbar/Logo/index.tsx +19 -0
  507. package/src/theme/Navbar/MobileSidebar/Header/index.tsx +34 -0
  508. package/src/theme/Navbar/MobileSidebar/Layout/index.tsx +31 -0
  509. package/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx +38 -0
  510. package/src/theme/Navbar/MobileSidebar/SecondaryMenu/index.tsx +39 -0
  511. package/src/theme/Navbar/MobileSidebar/Toggle/index.tsx +25 -0
  512. package/src/theme/Navbar/MobileSidebar/index.tsx +33 -0
  513. package/src/theme/Navbar/Search/index.tsx +19 -0
  514. package/src/theme/Navbar/Search/styles.module.css +20 -0
  515. package/src/theme/Navbar/index.tsx +7 -261
  516. package/src/theme/NavbarItem/ComponentTypes.tsx +32 -0
  517. package/src/theme/NavbarItem/DefaultNavbarItem.tsx +16 -65
  518. package/src/theme/NavbarItem/DocNavbarItem.tsx +13 -34
  519. package/src/theme/NavbarItem/DocSidebarNavbarItem.tsx +36 -0
  520. package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +43 -41
  521. package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx +5 -8
  522. package/src/theme/NavbarItem/DropdownNavbarItem.tsx +36 -28
  523. package/src/theme/NavbarItem/HtmlNavbarItem.tsx +32 -0
  524. package/src/theme/NavbarItem/LocaleDropdownNavbarItem/index.tsx +77 -0
  525. package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  526. package/src/theme/NavbarItem/NavbarNavLink.tsx +74 -0
  527. package/src/theme/NavbarItem/SearchNavbarItem.tsx +11 -3
  528. package/src/theme/NavbarItem/index.tsx +11 -48
  529. package/src/theme/NotFound.tsx +40 -37
  530. package/src/theme/PaginatorNavLink/index.tsx +26 -0
  531. package/src/theme/SearchBar.tsx +2 -1
  532. package/src/theme/SearchMetadata/index.tsx +43 -0
  533. package/src/theme/{LayoutHead → SiteMetadata}/index.tsx +31 -45
  534. package/src/theme/SkipToContent/index.tsx +5 -33
  535. package/src/theme/SkipToContent/styles.module.css +7 -0
  536. package/src/theme/TOC/index.tsx +14 -37
  537. package/src/theme/TOC/styles.module.css +1 -1
  538. package/src/theme/TOCCollapsible/CollapseButton/index.tsx +36 -0
  539. package/src/theme/TOCCollapsible/CollapseButton/styles.module.css +29 -0
  540. package/src/theme/TOCCollapsible/index.tsx +17 -20
  541. package/src/theme/TOCCollapsible/styles.module.css +1 -20
  542. package/src/theme/TOCInline/index.tsx +15 -35
  543. package/src/theme/TOCItems/Tree.tsx +46 -0
  544. package/src/theme/TOCItems/index.tsx +61 -0
  545. package/src/theme/TabItem/index.tsx +12 -4
  546. package/src/theme/TabItem/styles.module.css +10 -0
  547. package/src/theme/Tabs/index.tsx +121 -62
  548. package/src/theme/Tabs/styles.module.css +4 -13
  549. package/src/theme/Tag/index.tsx +27 -0
  550. package/src/theme/Tag/styles.module.css +70 -0
  551. package/src/theme/TagsListByLetter/index.tsx +43 -0
  552. package/src/theme/TagsListByLetter/styles.module.css +11 -0
  553. package/src/theme/TagsListInline/index.tsx +35 -0
  554. package/src/theme/TagsListInline/styles.module.css +15 -0
  555. package/src/theme/ThemedImage/index.tsx +10 -12
  556. package/src/theme/ThemedImage/styles.module.css +2 -2
  557. package/src/theme/prism-include-languages.ts +20 -15
  558. package/src/theme-classic.d.ts +1368 -0
  559. package/src/translations.ts +85 -60
  560. package/babel.config.js +0 -35
  561. package/codeTranslations/README.md +0 -20
  562. package/codeTranslations/ar.json +0 -56
  563. package/codeTranslations/base.json +0 -110
  564. package/codeTranslations/bn.json +0 -56
  565. package/codeTranslations/da.json +0 -56
  566. package/codeTranslations/de.json +0 -56
  567. package/codeTranslations/es.json +0 -56
  568. package/codeTranslations/fa.json +0 -56
  569. package/codeTranslations/fil.json +0 -56
  570. package/codeTranslations/fr.json +0 -56
  571. package/codeTranslations/he.json +0 -56
  572. package/codeTranslations/hi.json +0 -56
  573. package/codeTranslations/ja.json +0 -56
  574. package/codeTranslations/ko.json +0 -56
  575. package/codeTranslations/pl.json +0 -56
  576. package/codeTranslations/pt-BR.json +0 -56
  577. package/codeTranslations/pt-PT.json +0 -56
  578. package/codeTranslations/ru.json +0 -56
  579. package/codeTranslations/tr.json +0 -56
  580. package/codeTranslations/vi.json +0 -56
  581. package/codeTranslations/zh-Hans.json +0 -56
  582. package/codeTranslations/zh-Hant.json +0 -56
  583. package/lib/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  584. package/lib/__tests__/translations.test.js +0 -112
  585. package/lib/__tests__/validateThemeConfig.test.js +0 -457
  586. package/lib/theme/DocPage/styles.module.css +0 -85
  587. package/lib/theme/DocSidebar/styles.module.css +0 -106
  588. package/lib/theme/Heading/styles.css +0 -23
  589. package/lib/theme/IconArrow/index.js +0 -28
  590. package/lib/theme/IconEdit/index.js +0 -34
  591. package/lib/theme/IconExternalLink/index.js +0 -30
  592. package/lib/theme/IconLanguage/index.js +0 -29
  593. package/lib/theme/IconMenu/index.js +0 -30
  594. package/lib/theme/Layout/styles.css +0 -27
  595. package/lib/theme/LayoutHead/index.js +0 -144
  596. package/lib/theme/LayoutProviders/index.js +0 -38
  597. package/lib/theme/Navbar/styles.module.css +0 -23
  598. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem.js +0 -72
  599. package/lib/theme/SearchMetadatas/index.js +0 -33
  600. package/lib/theme/Seo/index.js +0 -49
  601. package/lib/theme/ThemeContext.js +0 -21
  602. package/lib/theme/ThemeProvider/index.js +0 -38
  603. package/lib/theme/Toggle/index.js +0 -94
  604. package/lib/theme/Toggle/styles.css +0 -103
  605. package/lib/theme/Toggle/styles.module.css +0 -17
  606. package/lib/theme/UserPreferencesContext.js +0 -18
  607. package/lib/theme/UserPreferencesProvider/index.js +0 -36
  608. package/lib/theme/hooks/styles.css +0 -10
  609. package/lib/theme/hooks/useContextualSearchFilters.js +0 -47
  610. package/lib/theme/hooks/useDocs.js +0 -18
  611. package/lib/theme/hooks/useHideableNavbar.js +0 -91
  612. package/lib/theme/hooks/useKeyboardNavigation.js +0 -45
  613. package/lib/theme/hooks/useLocationHash.js +0 -28
  614. package/lib/theme/hooks/useLockBodyScroll.js +0 -26
  615. package/lib/theme/hooks/usePrismTheme.js +0 -36
  616. package/lib/theme/hooks/useScrollPosition.js +0 -51
  617. package/lib/theme/hooks/useTOCHighlight.js +0 -87
  618. package/lib/theme/hooks/useTabGroupChoice.js +0 -51
  619. package/lib/theme/hooks/useTheme.js +0 -99
  620. package/lib/theme/hooks/useThemeContext.js +0 -31
  621. package/lib/theme/hooks/useUserPreferencesContext.js +0 -31
  622. package/lib/theme/hooks/useWindowSize.js +0 -73
  623. package/lib/types.d.ts +0 -696
  624. package/lib-next/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  625. package/lib-next/__tests__/translations.test.js +0 -128
  626. package/lib-next/__tests__/validateThemeConfig.test.js +0 -457
  627. package/lib-next/admonitions.css +0 -35
  628. package/lib-next/index.js +0 -222
  629. package/lib-next/theme/AnnouncementBar/index.js +0 -61
  630. package/lib-next/theme/AnnouncementBar/styles.module.css +0 -72
  631. package/lib-next/theme/BackToTopButton/index.js +0 -113
  632. package/lib-next/theme/BackToTopButton/styles.module.css +0 -39
  633. package/lib-next/theme/BlogLayout/index.js +0 -43
  634. package/lib-next/theme/BlogListPage/index.js +0 -47
  635. package/lib-next/theme/BlogListPaginator/index.js +0 -54
  636. package/lib-next/theme/BlogPostItem/index.js +0 -168
  637. package/lib-next/theme/BlogPostPage/index.js +0 -43
  638. package/lib-next/theme/BlogPostPaginator/index.js +0 -57
  639. package/lib-next/theme/BlogTagsListPage/index.js +0 -66
  640. package/lib-next/theme/BlogTagsPostsPage/index.js +0 -83
  641. package/lib-next/theme/CodeBlock/index.js +0 -266
  642. package/lib-next/theme/Details/index.js +0 -20
  643. package/lib-next/theme/Details/styles.module.css +0 -13
  644. package/lib-next/theme/DocItem/index.js +0 -131
  645. package/lib-next/theme/DocItem/styles.module.css +0 -32
  646. package/lib-next/theme/DocPage/index.js +0 -149
  647. package/lib-next/theme/DocPage/styles.module.css +0 -85
  648. package/lib-next/theme/DocPaginator/index.js +0 -59
  649. package/lib-next/theme/DocSidebar/index.js +0 -121
  650. package/lib-next/theme/DocSidebar/styles.module.css +0 -106
  651. package/lib-next/theme/DocSidebarItem/index.js +0 -161
  652. package/lib-next/theme/DocVersionBanner/index.js +0 -127
  653. package/lib-next/theme/EditThisPage/index.js +0 -21
  654. package/lib-next/theme/Footer/index.js +0 -129
  655. package/lib-next/theme/Heading/index.js +0 -67
  656. package/lib-next/theme/Heading/styles.module.css +0 -15
  657. package/lib-next/theme/IconLanguage/index.js +0 -25
  658. package/lib-next/theme/LastUpdated/index.js +0 -77
  659. package/lib-next/theme/Layout/index.js +0 -46
  660. package/lib-next/theme/LayoutHead/index.js +0 -137
  661. package/lib-next/theme/LayoutProviders/index.js +0 -29
  662. package/lib-next/theme/Logo/index.js +0 -54
  663. package/lib-next/theme/MDXComponents/index.js +0 -59
  664. package/lib-next/theme/MDXPage/index.js +0 -51
  665. package/lib-next/theme/Navbar/index.js +0 -254
  666. package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +0 -114
  667. package/lib-next/theme/NavbarItem/DocNavbarItem.js +0 -56
  668. package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +0 -87
  669. package/lib-next/theme/NavbarItem/DocsVersionNavbarItem.js +0 -28
  670. package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +0 -160
  671. package/lib-next/theme/NavbarItem/LocaleDropdownNavbarItem.js +0 -66
  672. package/lib-next/theme/NavbarItem/index.js +0 -52
  673. package/lib-next/theme/NotFound.js +0 -50
  674. package/lib-next/theme/SearchBar.js +0 -11
  675. package/lib-next/theme/SearchMetadatas/index.js +0 -20
  676. package/lib-next/theme/Seo/index.js +0 -36
  677. package/lib-next/theme/SkipToContent/index.js +0 -53
  678. package/lib-next/theme/SkipToContent/styles.module.css +0 -14
  679. package/lib-next/theme/TOC/index.js +0 -52
  680. package/lib-next/theme/TOC/styles.module.css +0 -23
  681. package/lib-next/theme/TOCCollapsible/index.js +0 -45
  682. package/lib-next/theme/TOCInline/index.js +0 -43
  683. package/lib-next/theme/Tabs/index.js +0 -144
  684. package/lib-next/theme/Tabs/styles.module.css +0 -23
  685. package/lib-next/theme/ThemeProvider/index.js +0 -25
  686. package/lib-next/theme/ThemedImage/index.js +0 -41
  687. package/lib-next/theme/ThemedImage/styles.module.css +0 -18
  688. package/lib-next/theme/Toggle/index.js +0 -80
  689. package/lib-next/theme/Toggle/styles.css +0 -103
  690. package/lib-next/theme/UserPreferencesContext.js +0 -9
  691. package/lib-next/theme/UserPreferencesProvider/index.js +0 -24
  692. package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
  693. package/lib-next/theme/hooks/useDocs.js +0 -10
  694. package/lib-next/theme/hooks/useHideableNavbar.js +0 -82
  695. package/lib-next/theme/hooks/useKeyboardNavigation.js +0 -35
  696. package/lib-next/theme/hooks/useLocationHash.js +0 -20
  697. package/lib-next/theme/hooks/useLockBodyScroll.js +0 -18
  698. package/lib-next/theme/hooks/usePrismTheme.js +0 -20
  699. package/lib-next/theme/hooks/useScrollPosition.js +0 -42
  700. package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
  701. package/lib-next/theme/hooks/useTabGroupChoice.js +0 -39
  702. package/lib-next/theme/hooks/useTheme.js +0 -82
  703. package/lib-next/theme/hooks/useThemeContext.js +0 -22
  704. package/lib-next/theme/hooks/useUserPreferencesContext.js +0 -22
  705. package/lib-next/theme/hooks/useWindowSize.js +0 -63
  706. package/lib-next/theme/prism-include-languages.js +0 -23
  707. package/lib-next/translations.js +0 -145
  708. package/lib-next/types.d.ts +0 -696
  709. package/lib-next/validateThemeConfig.js +0 -337
  710. package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  711. package/src/__tests__/translations.test.ts +0 -116
  712. package/src/__tests__/validateThemeConfig.test.js +0 -457
  713. package/src/prism-include-languages.js +0 -11
  714. package/src/theme/BlogSidebar/styles.module.css +0 -44
  715. package/src/theme/CodeBlock/styles.module.css +0 -66
  716. package/src/theme/DocItem/styles.module.css +0 -32
  717. package/src/theme/DocPage/styles.module.css +0 -85
  718. package/src/theme/DocSidebar/styles.module.css +0 -106
  719. package/src/theme/Heading/styles.css +0 -23
  720. package/src/theme/IconLanguage/index.tsx +0 -31
  721. package/src/theme/LayoutProviders/index.tsx +0 -32
  722. package/src/theme/SearchMetadatas/index.tsx +0 -28
  723. package/src/theme/Seo/index.tsx +0 -46
  724. package/src/theme/ThemeProvider/index.tsx +0 -24
  725. package/src/theme/Toggle/index.tsx +0 -100
  726. package/src/theme/Toggle/styles.css +0 -103
  727. package/src/theme/Toggle/styles.module.css +0 -17
  728. package/src/theme/UserPreferencesContext.ts +0 -12
  729. package/src/theme/UserPreferencesProvider/index.tsx +0 -27
  730. package/src/theme/hooks/styles.css +0 -10
  731. package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
  732. package/src/theme/hooks/useDocs.ts +0 -11
  733. package/src/theme/hooks/useHideableNavbar.ts +0 -87
  734. package/src/theme/hooks/useKeyboardNavigation.ts +0 -39
  735. package/src/theme/hooks/useLocationHash.ts +0 -25
  736. package/src/theme/hooks/usePrismTheme.ts +0 -22
  737. package/src/theme/hooks/useScrollPosition.ts +0 -52
  738. package/src/theme/hooks/useTOCHighlight.ts +0 -98
  739. package/src/theme/hooks/useTabGroupChoice.ts +0 -46
  740. package/src/theme/hooks/useTheme.ts +0 -92
  741. package/src/theme/hooks/useThemeContext.ts +0 -23
  742. package/src/theme/hooks/useUserPreferencesContext.ts +0 -25
  743. package/src/theme/hooks/useWindowSize.ts +0 -74
  744. package/src/types.d.ts +0 -696
  745. package/src/validateThemeConfig.js +0 -337
  746. package/tsconfig.json +0 -12
  747. package/update-code-translations.js +0 -242
  748. package/update-code-translations.test.js +0 -33
@@ -5,52 +5,75 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- const {Joi, URISchema} = require('@docusaurus/utils-validation');
8
+ import defaultPrismTheme from 'prism-react-renderer/themes/palenight';
9
+ import {Joi, URISchema} from '@docusaurus/utils-validation';
10
+ import type {Options, PluginOptions} from '@docusaurus/theme-classic';
11
+ import type {ThemeConfig} from '@docusaurus/theme-common';
12
+ import type {
13
+ ThemeConfigValidationContext,
14
+ OptionValidationContext,
15
+ } from '@docusaurus/types';
9
16
 
10
- const DEFAULT_DOCS_CONFIG = {
17
+ const DEFAULT_DOCS_CONFIG: ThemeConfig['docs'] = {
11
18
  versionPersistence: 'localStorage',
19
+ sidebar: {
20
+ hideable: false,
21
+ autoCollapseCategories: false,
22
+ },
12
23
  };
13
24
  const DocsSchema = Joi.object({
14
25
  versionPersistence: Joi.string()
15
26
  .equal('localStorage', 'none')
16
27
  .default(DEFAULT_DOCS_CONFIG.versionPersistence),
28
+ sidebar: Joi.object({
29
+ hideable: Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.hideable),
30
+ autoCollapseCategories: Joi.bool().default(
31
+ DEFAULT_DOCS_CONFIG.sidebar.autoCollapseCategories,
32
+ ),
33
+ }).default(DEFAULT_DOCS_CONFIG.sidebar),
17
34
  }).default(DEFAULT_DOCS_CONFIG);
18
35
 
19
- const DEFAULT_COLOR_MODE_CONFIG = {
36
+ const DEFAULT_COLOR_MODE_CONFIG: ThemeConfig['colorMode'] = {
20
37
  defaultMode: 'light',
21
38
  disableSwitch: false,
22
39
  respectPrefersColorScheme: false,
23
- switchConfig: {
24
- darkIcon: '🌜',
25
- darkIconStyle: {},
26
- lightIcon: '🌞',
27
- lightIconStyle: {},
28
- },
29
40
  };
30
41
 
31
- const DEFAULT_CONFIG = {
42
+ export const DEFAULT_CONFIG: ThemeConfig = {
32
43
  colorMode: DEFAULT_COLOR_MODE_CONFIG,
33
44
  docs: DEFAULT_DOCS_CONFIG,
34
- metadatas: [],
45
+ metadata: [],
35
46
  prism: {
36
47
  additionalLanguages: [],
48
+ theme: defaultPrismTheme,
49
+ magicComments: [
50
+ {
51
+ className: 'theme-code-block-highlighted-line',
52
+ line: 'highlight-next-line',
53
+ block: {start: 'highlight-start', end: 'highlight-end'},
54
+ },
55
+ ],
37
56
  },
38
57
  navbar: {
39
58
  hideOnScroll: false,
40
59
  items: [],
41
60
  },
42
- hideableSidebar: false,
61
+ tableOfContents: {
62
+ minHeadingLevel: 2,
63
+ maxHeadingLevel: 3,
64
+ },
43
65
  };
44
- exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
45
66
 
46
67
  const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
47
68
 
48
69
  const NavbarItemBaseSchema = Joi.object({
49
70
  label: Joi.string(),
71
+ html: Joi.string(),
50
72
  className: Joi.string(),
51
73
  })
52
- // We allow any unknown attributes on the links
53
- // (users may need additional attributes like target, aria-role, data-customAttribute...)
74
+ .nand('html', 'label')
75
+ // We allow any unknown attributes on the links (users may need additional
76
+ // attributes like target, aria-role, data-customAttribute...)
54
77
  .unknown();
55
78
 
56
79
  const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
@@ -79,14 +102,36 @@ const DocItemSchema = NavbarItemBaseSchema.append({
79
102
  type: Joi.string().equal('doc').required(),
80
103
  docId: Joi.string().required(),
81
104
  docsPluginId: Joi.string(),
82
- activeSidebarClassName: Joi.string().default('navbar__link--active'),
83
105
  });
84
106
 
85
- const itemWithType = (type) => {
86
- // because equal(undefined) is not supported :/
87
- const typeSchema = type
88
- ? Joi.string().required().equal(type)
89
- : Joi.string().forbidden();
107
+ const DocSidebarItemSchema = NavbarItemBaseSchema.append({
108
+ type: Joi.string().equal('docSidebar').required(),
109
+ sidebarId: Joi.string().required(),
110
+ docsPluginId: Joi.string(),
111
+ });
112
+
113
+ const HtmlNavbarItemSchema = Joi.object({
114
+ className: Joi.string(),
115
+ type: Joi.string().equal('html').required(),
116
+ value: Joi.string().required(),
117
+ });
118
+
119
+ // A temporary workaround to allow users to add custom navbar items
120
+ // See https://github.com/facebook/docusaurus/issues/7227
121
+ const CustomNavbarItemRegexp = /custom-.*/;
122
+ const CustomNavbarItemSchema = Joi.object({
123
+ type: Joi.string().regex(CustomNavbarItemRegexp).required(),
124
+ }).unknown();
125
+
126
+ const itemWithType = (type: string | RegExp | undefined) => {
127
+ // Because equal(undefined) is not supported :/
128
+ const typeSchema =
129
+ // eslint-disable-next-line no-nested-ternary
130
+ type instanceof RegExp
131
+ ? Joi.string().required().regex(type)
132
+ : type
133
+ ? Joi.string().required().equal(type)
134
+ : Joi.string().forbidden();
90
135
  return Joi.object({
91
136
  type: typeSchema,
92
137
  })
@@ -96,7 +141,7 @@ const itemWithType = (type) => {
96
141
 
97
142
  const DropdownSubitemSchema = Joi.object({
98
143
  position: Joi.forbidden(),
99
- }).when({
144
+ }).when('.', {
100
145
  switch: [
101
146
  {
102
147
  is: itemWithType('docsVersion'),
@@ -106,10 +151,22 @@ const DropdownSubitemSchema = Joi.object({
106
151
  is: itemWithType('doc'),
107
152
  then: DocItemSchema,
108
153
  },
154
+ {
155
+ is: itemWithType('docSidebar'),
156
+ then: DocSidebarItemSchema,
157
+ },
109
158
  {
110
159
  is: itemWithType(undefined),
111
160
  then: DefaultNavbarItemSchema,
112
161
  },
162
+ {
163
+ is: itemWithType('html'),
164
+ then: HtmlNavbarItemSchema,
165
+ },
166
+ {
167
+ is: itemWithType(CustomNavbarItemRegexp),
168
+ then: CustomNavbarItemSchema,
169
+ },
113
170
  {
114
171
  is: Joi.alternatives().try(
115
172
  itemWithType('dropdown'),
@@ -147,11 +204,12 @@ const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
147
204
 
148
205
  const SearchItemSchema = Joi.object({
149
206
  type: Joi.string().equal('search').required(),
207
+ className: Joi.string(),
150
208
  });
151
209
 
152
210
  const NavbarItemSchema = Joi.object({
153
211
  position: NavbarItemPosition,
154
- }).when({
212
+ }).when('.', {
155
213
  switch: [
156
214
  {
157
215
  is: itemWithType('docsVersion'),
@@ -169,6 +227,10 @@ const NavbarItemSchema = Joi.object({
169
227
  is: itemWithType('doc'),
170
228
  then: DocItemSchema,
171
229
  },
230
+ {
231
+ is: itemWithType('docSidebar'),
232
+ then: DocSidebarItemSchema,
233
+ },
172
234
  {
173
235
  is: itemWithType('localeDropdown'),
174
236
  then: LocaleDropdownNavbarItemSchema,
@@ -177,9 +239,17 @@ const NavbarItemSchema = Joi.object({
177
239
  is: itemWithType('search'),
178
240
  then: SearchItemSchema,
179
241
  },
242
+ {
243
+ is: itemWithType('html'),
244
+ then: HtmlNavbarItemSchema,
245
+ },
246
+ {
247
+ is: itemWithType(CustomNavbarItemRegexp),
248
+ then: CustomNavbarItemSchema,
249
+ },
180
250
  {
181
251
  is: itemWithType(undefined),
182
- then: Joi.object().when({
252
+ then: Joi.object().when('.', {
183
253
  // Dropdown item can be specified without type field
184
254
  is: Joi.object({
185
255
  items: Joi.array().required(),
@@ -202,23 +272,12 @@ const ColorModeSchema = Joi.object({
202
272
  respectPrefersColorScheme: Joi.bool().default(
203
273
  DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme,
204
274
  ),
205
- switchConfig: Joi.object({
206
- darkIcon: Joi.string().default(
207
- DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIcon,
208
- ),
209
- darkIconStyle: Joi.object().default(
210
- DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIconStyle,
211
- ),
212
- lightIcon: Joi.string().default(
213
- DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIcon,
214
- ),
215
- lightIconStyle: Joi.object().default(
216
- DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIconStyle,
217
- ),
218
- }).default(DEFAULT_COLOR_MODE_CONFIG.switchConfig),
275
+ switchConfig: Joi.any().forbidden().messages({
276
+ 'any.unknown':
277
+ 'colorMode.switchConfig is deprecated. If you want to customize the icons for light and dark mode, swizzle IconLightMode, IconDarkMode, or ColorModeToggle instead.',
278
+ }),
219
279
  }).default(DEFAULT_COLOR_MODE_CONFIG);
220
280
 
221
- // schema can probably be improved
222
281
  const HtmlMetadataSchema = Joi.object({
223
282
  id: Joi.string(),
224
283
  name: Joi.string(),
@@ -237,35 +296,49 @@ const FooterLinkItemSchema = Joi.object({
237
296
  .with('to', 'label')
238
297
  .with('href', 'label')
239
298
  .nand('html', 'label')
240
- // We allow any unknown attributes on the links
241
- // (users may need additional attributes like target, aria-role, data-customAttribute...)
299
+ // We allow any unknown attributes on the links (users may need additional
300
+ // attributes like target, aria-role, data-customAttribute...)
242
301
  .unknown();
243
302
 
244
- const CustomCssSchema = Joi.alternatives()
245
- .try(Joi.array().items(Joi.string().required()), Joi.string().required())
246
- .optional();
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
+ });
247
314
 
248
- const ThemeConfigSchema = Joi.object({
315
+ export const ThemeConfigSchema = Joi.object<ThemeConfig>({
249
316
  // TODO temporary (@alpha-58)
250
- disableDarkMode: Joi.any().forbidden(false).messages({
317
+ // @ts-expect-error: forbidden
318
+ disableDarkMode: Joi.any().forbidden().messages({
251
319
  'any.unknown':
252
320
  'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
253
321
  }),
254
322
  // TODO temporary (@alpha-58)
255
- defaultDarkMode: Joi.any().forbidden(false).messages({
323
+ defaultDarkMode: Joi.any().forbidden().messages({
256
324
  'any.unknown':
257
325
  'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
258
326
  }),
259
- customCss: CustomCssSchema,
260
327
  colorMode: ColorModeSchema,
261
328
  image: Joi.string(),
262
329
  docs: DocsSchema,
263
- metadatas: Joi.array()
330
+ metadata: Joi.array()
264
331
  .items(HtmlMetadataSchema)
265
- .default(DEFAULT_CONFIG.metadatas),
332
+ .default(DEFAULT_CONFIG.metadata),
333
+ // cSpell:ignore metadatas
334
+ metadatas: Joi.any().forbidden().messages({
335
+ 'any.unknown':
336
+ // cSpell:ignore metadatas
337
+ 'themeConfig.metadatas has been renamed as themeConfig.metadata. See https://github.com/facebook/docusaurus/pull/5871',
338
+ }),
266
339
  announcementBar: Joi.object({
267
340
  id: Joi.string().default('announcement-bar'),
268
- content: Joi.string(),
341
+ content: Joi.string().required(),
269
342
  backgroundColor: Joi.string(),
270
343
  textColor: Joi.string(),
271
344
  isCloseable: Joi.bool().default(true),
@@ -282,37 +355,31 @@ const ThemeConfigSchema = Joi.object({
282
355
  .items(NavbarItemSchema)
283
356
  .default(DEFAULT_CONFIG.navbar.items),
284
357
  title: Joi.string().allow('', null),
285
- logo: Joi.object({
286
- alt: Joi.string().allow(''),
287
- src: Joi.string().required(),
288
- srcDark: Joi.string(),
289
- href: Joi.string(),
290
- target: Joi.string(),
291
- }),
358
+ logo: LogoSchema,
292
359
  }).default(DEFAULT_CONFIG.navbar),
293
360
  footer: Joi.object({
294
361
  style: Joi.string().equal('dark', 'light').default('light'),
295
- logo: Joi.object({
296
- alt: Joi.string().allow(''),
297
- src: Joi.string(),
298
- srcDark: Joi.string(),
299
- href: Joi.string(),
300
- }),
362
+ logo: LogoSchema,
301
363
  copyright: Joi.string(),
302
- links: Joi.array()
303
- .items(
364
+ links: Joi.alternatives(
365
+ Joi.array().items(
304
366
  Joi.object({
305
- title: Joi.string().allow(null),
367
+ title: Joi.string().allow(null).default(null),
306
368
  items: Joi.array().items(FooterLinkItemSchema).default([]),
307
369
  }),
308
- )
370
+ ),
371
+ Joi.array().items(FooterLinkItemSchema),
372
+ )
373
+ .messages({
374
+ '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`,
375
+ })
309
376
  .default([]),
310
377
  }).optional(),
311
378
  prism: Joi.object({
312
379
  theme: Joi.object({
313
380
  plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
314
381
  styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
315
- }),
382
+ }).default(DEFAULT_CONFIG.prism.theme),
316
383
  darkTheme: Joi.object({
317
384
  plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
318
385
  styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
@@ -321,17 +388,82 @@ const ThemeConfigSchema = Joi.object({
321
388
  additionalLanguages: Joi.array()
322
389
  .items(Joi.string())
323
390
  .default(DEFAULT_CONFIG.prism.additionalLanguages),
391
+ magicComments: Joi.array()
392
+ .items(
393
+ Joi.object({
394
+ className: Joi.string().required(),
395
+ line: Joi.string(),
396
+ block: Joi.object({
397
+ start: Joi.string().required(),
398
+ end: Joi.string().required(),
399
+ }),
400
+ }).or('line', 'block'),
401
+ )
402
+ .default(DEFAULT_CONFIG.prism.magicComments),
324
403
  })
325
404
  .default(DEFAULT_CONFIG.prism)
326
405
  .unknown(),
327
- hideableSidebar: Joi.bool().default(DEFAULT_CONFIG.hideableSidebar),
406
+ hideableSidebar: Joi.forbidden().messages({
407
+ 'any.unknown':
408
+ 'themeConfig.hideableSidebar has been moved to themeConfig.docs.sidebar.hideable.',
409
+ }),
410
+ autoCollapseSidebarCategories: Joi.forbidden().messages({
411
+ 'any.unknown':
412
+ 'themeConfig.autoCollapseSidebarCategories has been moved to themeConfig.docs.sidebar.autoCollapseCategories.',
413
+ }),
328
414
  sidebarCollapsible: Joi.forbidden().messages({
329
415
  'any.unknown':
330
416
  'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs',
331
417
  }),
418
+ tableOfContents: Joi.object({
419
+ minHeadingLevel: Joi.number()
420
+ .default(DEFAULT_CONFIG.tableOfContents.minHeadingLevel)
421
+ .when('maxHeadingLevel', {
422
+ is: Joi.exist(),
423
+ then: Joi.number()
424
+ .integer()
425
+ .min(2)
426
+ .max(6)
427
+ .max(Joi.ref('maxHeadingLevel')),
428
+ otherwise: Joi.number().integer().min(2).max(6),
429
+ }),
430
+ maxHeadingLevel: Joi.number()
431
+ .integer()
432
+ .min(2)
433
+ .max(6)
434
+ .default(DEFAULT_CONFIG.tableOfContents.maxHeadingLevel),
435
+ }).default(DEFAULT_CONFIG.tableOfContents),
332
436
  });
333
- exports.ThemeConfigSchema = ThemeConfigSchema;
334
437
 
335
- exports.validateThemeConfig = ({validate, themeConfig}) => {
438
+ export function validateThemeConfig({
439
+ validate,
440
+ themeConfig,
441
+ }: ThemeConfigValidationContext<ThemeConfig>): ThemeConfig {
336
442
  return validate(ThemeConfigSchema, themeConfig);
443
+ }
444
+
445
+ const DEFAULT_OPTIONS = {
446
+ customCss: [],
337
447
  };
448
+
449
+ const PluginOptionSchema = Joi.object<PluginOptions>({
450
+ customCss: Joi.alternatives()
451
+ .try(
452
+ Joi.array().items(Joi.string().required()),
453
+ Joi.alternatives().conditional(Joi.string().required(), {
454
+ then: Joi.custom((val: string) => [val]),
455
+ otherwise: Joi.forbidden().messages({
456
+ 'any.unknown': '"customCss" must be a string or an array of strings',
457
+ }),
458
+ }),
459
+ )
460
+ .default(DEFAULT_OPTIONS.customCss),
461
+ });
462
+
463
+ export function validateOptions({
464
+ validate,
465
+ options,
466
+ }: OptionValidationContext<Options, PluginOptions>): PluginOptions {
467
+ const validatedOptions = validate(PluginOptionSchema, options);
468
+ return validatedOptions;
469
+ }
@@ -0,0 +1,209 @@
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 React, {type ReactNode} from 'react';
9
+ import clsx from 'clsx';
10
+ import {ThemeClassNames} from '@docusaurus/theme-common';
11
+ import Translate from '@docusaurus/Translate';
12
+ import type {Props} from '@theme/Admonition';
13
+
14
+ import styles from './styles.module.css';
15
+
16
+ function NoteIcon() {
17
+ return (
18
+ <svg viewBox="0 0 14 16">
19
+ <path
20
+ fillRule="evenodd"
21
+ d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"
22
+ />
23
+ </svg>
24
+ );
25
+ }
26
+
27
+ function TipIcon() {
28
+ return (
29
+ <svg viewBox="0 0 12 16">
30
+ <path
31
+ fillRule="evenodd"
32
+ d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"
33
+ />
34
+ </svg>
35
+ );
36
+ }
37
+
38
+ function DangerIcon() {
39
+ return (
40
+ <svg viewBox="0 0 12 16">
41
+ <path
42
+ fillRule="evenodd"
43
+ d="M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"
44
+ />
45
+ </svg>
46
+ );
47
+ }
48
+
49
+ function InfoIcon() {
50
+ return (
51
+ <svg viewBox="0 0 14 16">
52
+ <path
53
+ fillRule="evenodd"
54
+ d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"
55
+ />
56
+ </svg>
57
+ );
58
+ }
59
+
60
+ function CautionIcon() {
61
+ return (
62
+ <svg viewBox="0 0 16 16">
63
+ <path
64
+ fillRule="evenodd"
65
+ d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"
66
+ />
67
+ </svg>
68
+ );
69
+ }
70
+
71
+ type AdmonitionConfig = {
72
+ iconComponent: React.ComponentType;
73
+ infimaClassName: string;
74
+ label: ReactNode;
75
+ };
76
+
77
+ // eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
78
+ const AdmonitionConfigs: Record<Props['type'], AdmonitionConfig> = {
79
+ note: {
80
+ infimaClassName: 'secondary',
81
+ iconComponent: NoteIcon,
82
+ label: (
83
+ <Translate
84
+ id="theme.admonition.note"
85
+ description="The default label used for the Note admonition (:::note)">
86
+ note
87
+ </Translate>
88
+ ),
89
+ },
90
+ tip: {
91
+ infimaClassName: 'success',
92
+ iconComponent: TipIcon,
93
+ label: (
94
+ <Translate
95
+ id="theme.admonition.tip"
96
+ description="The default label used for the Tip admonition (:::tip)">
97
+ tip
98
+ </Translate>
99
+ ),
100
+ },
101
+ danger: {
102
+ infimaClassName: 'danger',
103
+ iconComponent: DangerIcon,
104
+ label: (
105
+ <Translate
106
+ id="theme.admonition.danger"
107
+ description="The default label used for the Danger admonition (:::danger)">
108
+ danger
109
+ </Translate>
110
+ ),
111
+ },
112
+ info: {
113
+ infimaClassName: 'info',
114
+ iconComponent: InfoIcon,
115
+ label: (
116
+ <Translate
117
+ id="theme.admonition.info"
118
+ description="The default label used for the Info admonition (:::info)">
119
+ info
120
+ </Translate>
121
+ ),
122
+ },
123
+ caution: {
124
+ infimaClassName: 'warning',
125
+ iconComponent: CautionIcon,
126
+ label: (
127
+ <Translate
128
+ id="theme.admonition.caution"
129
+ description="The default label used for the Caution admonition (:::caution)">
130
+ caution
131
+ </Translate>
132
+ ),
133
+ },
134
+ };
135
+
136
+ // Legacy aliases, undocumented but kept for retro-compatibility
137
+ const aliases = {
138
+ secondary: 'note',
139
+ important: 'info',
140
+ success: 'tip',
141
+ warning: 'danger',
142
+ } as const;
143
+
144
+ function getAdmonitionConfig(unsafeType: string): AdmonitionConfig {
145
+ const type =
146
+ (aliases as {[key: string]: Props['type']})[unsafeType] ?? unsafeType;
147
+ const config = (AdmonitionConfigs as {[key: string]: AdmonitionConfig})[type];
148
+ if (config) {
149
+ return config;
150
+ }
151
+ console.warn(
152
+ `No admonition config found for admonition type "${type}". Using Info as fallback.`,
153
+ );
154
+ return AdmonitionConfigs.info;
155
+ }
156
+
157
+ // Workaround because it's difficult in MDX v1 to provide a MDX title as props
158
+ // See https://github.com/facebook/docusaurus/pull/7152#issuecomment-1145779682
159
+ function extractMDXAdmonitionTitle(children: ReactNode): {
160
+ mdxAdmonitionTitle: ReactNode | undefined;
161
+ rest: ReactNode;
162
+ } {
163
+ const items = React.Children.toArray(children);
164
+ const mdxAdmonitionTitle = items.find(
165
+ (item) =>
166
+ React.isValidElement(item) &&
167
+ (item.props as {mdxType: string} | null)?.mdxType ===
168
+ 'mdxAdmonitionTitle',
169
+ );
170
+ const rest = <>{items.filter((item) => item !== mdxAdmonitionTitle)}</>;
171
+ return {
172
+ mdxAdmonitionTitle,
173
+ rest,
174
+ };
175
+ }
176
+
177
+ function processAdmonitionProps(props: Props): Props {
178
+ const {mdxAdmonitionTitle, rest} = extractMDXAdmonitionTitle(props.children);
179
+ return {
180
+ ...props,
181
+ title: props.title ?? mdxAdmonitionTitle,
182
+ children: rest,
183
+ };
184
+ }
185
+
186
+ export default function Admonition(props: Props): JSX.Element {
187
+ const {children, type, title, icon: iconProp} = processAdmonitionProps(props);
188
+
189
+ const typeConfig = getAdmonitionConfig(type);
190
+ const titleLabel = title ?? typeConfig.label;
191
+ const {iconComponent: IconComponent} = typeConfig;
192
+ const icon = iconProp ?? <IconComponent />;
193
+ return (
194
+ <div
195
+ className={clsx(
196
+ ThemeClassNames.common.admonition,
197
+ ThemeClassNames.common.admonitionType(props.type),
198
+ 'alert',
199
+ `alert--${typeConfig.infimaClassName}`,
200
+ styles.admonition,
201
+ )}>
202
+ <div className={styles.admonitionHeading}>
203
+ <span className={styles.admonitionIcon}>{icon}</span>
204
+ {titleLabel}
205
+ </div>
206
+ <div className={styles.admonitionContent}>{children}</div>
207
+ </div>
208
+ );
209
+ }
@@ -5,31 +5,34 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
 
8
- .admonition h5 {
9
- margin-top: 0;
10
- margin-bottom: 8px;
8
+ .admonition {
9
+ margin-bottom: 1em;
10
+ }
11
+
12
+ .admonitionHeading {
13
+ font: var(--ifm-heading-font-weight) var(--ifm-h5-font-size) /
14
+ var(--ifm-heading-line-height) var(--ifm-heading-font-family);
11
15
  text-transform: uppercase;
16
+ margin-bottom: 0.3rem;
17
+ }
18
+
19
+ .admonitionHeading code {
20
+ text-transform: none;
12
21
  }
13
22
 
14
- .admonition-icon {
23
+ .admonitionIcon {
15
24
  display: inline-block;
16
25
  vertical-align: middle;
17
26
  margin-right: 0.4em;
18
27
  }
19
28
 
20
- .admonition-icon svg {
29
+ .admonitionIcon svg {
21
30
  display: inline-block;
22
- width: 22px;
23
- height: 22px;
24
- stroke-width: 0;
31
+ height: 1.6em;
32
+ width: 1.6em;
25
33
  fill: var(--ifm-alert-foreground-color);
26
- stroke: var(--ifm-alert-foreground-color);
27
34
  }
28
35
 
29
- .admonition-content > :last-child {
36
+ .admonitionContent > :last-child {
30
37
  margin-bottom: 0;
31
38
  }
32
-
33
- .admonition {
34
- margin-bottom: 1em;
35
- }