@docusaurus/theme-common 2.0.0-beta.15d451942 → 2.0.0-beta.18

package/lib/hooks/useWindowSize.js

@@ -0,0 +1,59 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import { useEffect, useState } from 'react';
+import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
+const windowSizes = {
+    desktop: 'desktop',
+    mobile: 'mobile',
+    ssr: 'ssr',
+};
+const DesktopThresholdWidth = 996;
+function getWindowSize() {
+    if (!ExecutionEnvironment.canUseDOM) {
+        return windowSizes.ssr;
+    }
+    return window.innerWidth > DesktopThresholdWidth
+        ? windowSizes.desktop
+        : windowSizes.mobile;
+}
+const DevSimulateSSR = process.env.NODE_ENV === 'development' && true;
+/**
+ * Gets the current window size as an enum value. We don't want it to return the
+ * actual width value, so that it only re-renders once a breakpoint is crossed.
+ *
+ * It may return `"ssr"`, which is very important to handle hydration FOUC or
+ * layout shifts. You have to handle it explicitly upfront. On the server, you
+ * may need to render BOTH the mobile/desktop elements (and hide one of them
+ * with mediaquery). We don't return `undefined` on purpose, to make it more
+ * explicit.
+ *
+ * In development mode, this hook will still return `"ssr"` for one second, to
+ * catch potential layout shifts, similar to strict mode calling effects twice.
+ */
+export function useWindowSize() {
+    const [windowSize, setWindowSize] = useState(() => {
+        if (DevSimulateSSR) {
+            return 'ssr';
+        }
+        return getWindowSize();
+    });
+    useEffect(() => {
+        function updateWindowSize() {
+            setWindowSize(getWindowSize());
+        }
+        const timeout = DevSimulateSSR
+            ? window.setTimeout(updateWindowSize, 1000)
+            : undefined;
+        window.addEventListener('resize', updateWindowSize);
+        return () => {
+            window.removeEventListener('resize', updateWindowSize);
+            clearTimeout(timeout);
+        };
+    }, []);
+    return windowSize;
+}
+//# sourceMappingURL=useWindowSize.js.map

package/lib/hooks/useWindowSize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useWindowSize.js","sourceRoot":"","sources":["../../src/hooks/useWindowSize.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAC,SAAS,EAAE,QAAQ,EAAC,MAAM,OAAO,CAAC;AAE1C,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AAEpE,MAAM,WAAW,GAAG;IAClB,OAAO,EAAE,SAAS;IAClB,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;CACF,CAAC;AAIX,MAAM,qBAAqB,GAAG,GAAG,CAAC;AAElC,SAAS,aAAa;IACpB,IAAI,CAAC,oBAAoB,CAAC,SAAS,EAAE;QACnC,OAAO,WAAW,CAAC,GAAG,CAAC;KACxB;IACD,OAAO,MAAM,CAAC,UAAU,GAAG,qBAAqB;QAC9C,CAAC,CAAC,WAAW,CAAC,OAAO;QACrB,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC;AACzB,CAAC;AAED,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,IAAI,CAAC;AAEtE;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,aAAa;IAC3B,MAAM,CAAC,UAAU,EAAE,aAAa,CAAC,GAAG,QAAQ,CAAa,GAAG,EAAE;QAC5D,IAAI,cAAc,EAAE;YAClB,OAAO,KAAK,CAAC;SACd;QACD,OAAO,aAAa,EAAE,CAAC;IACzB,CAAC,CAAC,CAAC;IAEH,SAAS,CAAC,GAAG,EAAE;QACb,SAAS,gBAAgB;YACvB,aAAa,CAAC,aAAa,EAAE,CAAC,CAAC;QACjC,CAAC;QAED,MAAM,OAAO,GAAG,cAAc;YAC5B,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,gBAAgB,EAAE,IAAI,CAAC;YAC3C,CAAC,CAAC,SAAS,CAAC;QAEd,MAAM,CAAC,gBAAgB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;QAEpD,OAAO,GAAG,EAAE;YACV,MAAM,CAAC,mBAAmB,CAAC,QAAQ,EAAE,gBAAgB,CAAC,CAAC;YACvD,YAAY,CAAC,OAAO,CAAC,CAAC;QACxB,CAAC,CAAC;IACJ,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,UAAU,CAAC;AACpB,CAAC"}

package/lib/index.d.ts

@@ -4,17 +4,44 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export { useThemeConfig } from './utils/useThemeConfig';
-export type { ThemeConfig, Navbar, NavbarItem, NavbarLogo, Footer, FooterLinks, FooterLinkItem, } from './utils/useThemeConfig';
+export { useThemeConfig, type ThemeConfig, type UserThemeConfig, type Navbar, type NavbarItem, type NavbarLogo, type MultiColumnFooter, type SimpleFooter, type Footer, type FooterLogo, type FooterLinkItem, type ColorModeConfig, } from './utils/useThemeConfig';
+export { DocSidebarItemsExpandedStateProvider, useDocSidebarItemsExpandedState, } from './contexts/docSidebarItemsExpandedState';
+export { DocsVersionProvider, useDocsVersion } from './contexts/docsVersion';
+export { DocsSidebarProvider, useDocsSidebar } from './contexts/docsSidebar';
 export { createStorageSlot, listStorageKeys } from './utils/storageUtils';
 export { useAlternatePageUtils } from './utils/useAlternatePageUtils';
-export { parseCodeBlockTitle } from './utils/codeBlockUtils';
-export { docVersionSearchTag, DEFAULT_SEARCH_TAG } from './utils/searchUtils';
-export { isDocsPluginEnabled } from './utils/docsUtils';
-export { isSamePath } from './utils/pathUtils';
+export { parseCodeBlockTitle, parseLanguage, parseLines, } from './utils/codeBlockUtils';
+export { docVersionSearchTag, DEFAULT_SEARCH_TAG, useContextualSearchFilters, } from './utils/searchUtils';
+export { isDocsPluginEnabled, useDocById, findSidebarCategory, findFirstCategoryLink, useCurrentSidebarCategory, isActiveSidebarItem, useSidebarBreadcrumbs, } from './utils/docsUtils';
 export { useTitleFormatter } from './utils/generalUtils';
 export { usePluralForm } from './utils/usePluralForm';
-export { useChangeRoute } from './utils/useChangeRoute';
-export { useDocsPreferredVersion, useDocsPreferredVersionByPluginId, } from './utils/docsPreferredVersion/useDocsPreferredVersion';
-export { DocsPreferredVersionContextProvider } from './utils/docsPreferredVersion/DocsPreferredVersionProvider';
+export { useLocationChange } from './utils/useLocationChange';
+export { useCollapsible, Collapsible } from './components/Collapsible';
+export { Details, type DetailsProps } from './components/Details';
+export { useDocsPreferredVersion, useDocsPreferredVersionByPluginId, DocsPreferredVersionContextProvider, } from './contexts/docsPreferredVersion';
+export { duplicates, uniq } from './utils/jsUtils';
 export { ThemeClassNames } from './utils/ThemeClassNames';
+export { AnnouncementBarProvider, useAnnouncementBar, } from './contexts/announcementBar';
+export { useLocalPathname } from './utils/useLocalPathname';
+export { translateTagsPageTitle, listTagsByLetters, type TagLetterEntry, type TagsListItem, } from './utils/tagsUtils';
+export { useHistoryPopHandler } from './utils/historyUtils';
+export { useTOCHighlight, type TOCHighlightConfig, } from './hooks/useTOCHighlight';
+export { useFilteredAndTreeifiedTOC, useTreeifiedTOC, type TOCTreeNode, } from './utils/tocUtils';
+export { isMultiColumnFooterLinks } from './utils/footerUtils';
+export { ScrollControllerProvider, useScrollController, useScrollPosition, useScrollPositionBlocker, } from './utils/scrollUtils';
+export { useIsomorphicLayoutEffect, useDynamicCallback, usePrevious, ReactContextError, } from './utils/reactUtils';
+export { isRegexpStringMatch } from './utils/regexpUtils';
+export { useHomePageRoute, isSamePath } from './utils/routesUtils';
+export { PageMetadata, HtmlClassNameProvider, PluginHtmlClassNameProvider, } from './utils/metadataUtils';
+export { useColorMode, ColorModeProvider, type ColorMode, } from './contexts/colorMode';
+export { splitNavbarItems, NavbarProvider } from './utils/navbarUtils';
+export { useTabGroupChoice, TabGroupChoiceProvider, } from './contexts/tabGroupChoice';
+export { useNavbarMobileSidebar } from './contexts/navbarMobileSidebar';
+export { useNavbarSecondaryMenu, NavbarSecondaryMenuFiller, type NavbarSecondaryMenuComponent, } from './contexts/navbarSecondaryMenu';
+export { useHideableNavbar } from './hooks/useHideableNavbar';
+export { useKeyboardNavigation, keyboardFocusedClassName, } from './hooks/useKeyboardNavigation';
+export { usePrismTheme } from './hooks/usePrismTheme';
+export { useLockBodyScroll } from './hooks/useLockBodyScroll';
+export { useWindowSize } from './hooks/useWindowSize';
+export { useSearchPage } from './hooks/useSearchPage';
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,cAAc,EACd,KAAK,WAAW,EAChB,KAAK,eAAe,EACpB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,UAAU,EACf,KAAK,iBAAiB,EACtB,KAAK,YAAY,EACjB,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,cAAc,EACnB,KAAK,eAAe,GACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oCAAoC,EACpC,+BAA+B,GAChC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,GACX,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,GAC3B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,OAAO,EAAE,KAAK,YAAY,EAAC,MAAM,sBAAsB,CAAC;AAEhE,OAAO,EACL,uBAAuB,EACvB,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACL,sBAAsB,EACtB,iBAAiB,EACjB,KAAK,cAAc,EACnB,KAAK,YAAY,GAClB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EACL,eAAe,EACf,KAAK,kBAAkB,GACxB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACL,0BAA0B,EAC1B,eAAe,EACf,KAAK,WAAW,GACjB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,WAAW,EACX,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,gBAAgB,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EACL,YAAY,EACZ,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,YAAY,EACZ,iBAAiB,EACjB,KAAK,SAAS,GACf,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAErE,OAAO,EACL,iBAAiB,EACjB,sBAAsB,GACvB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AACtE,OAAO,EACL,sBAAsB,EACtB,yBAAyB,EACzB,KAAK,4BAA4B,GAClC,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC"}

package/lib/index.js

@@ -4,16 +4,44 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-export { useThemeConfig } from './utils/useThemeConfig';
+export { useThemeConfig, } from './utils/useThemeConfig';
+export { DocSidebarItemsExpandedStateProvider, useDocSidebarItemsExpandedState, } from './contexts/docSidebarItemsExpandedState';
+export { DocsVersionProvider, useDocsVersion } from './contexts/docsVersion';
+export { DocsSidebarProvider, useDocsSidebar } from './contexts/docsSidebar';
 export { createStorageSlot, listStorageKeys } from './utils/storageUtils';
 export { useAlternatePageUtils } from './utils/useAlternatePageUtils';
-export { parseCodeBlockTitle } from './utils/codeBlockUtils';
-export { docVersionSearchTag, DEFAULT_SEARCH_TAG } from './utils/searchUtils';
-export { isDocsPluginEnabled } from './utils/docsUtils';
-export { isSamePath } from './utils/pathUtils';
+export { parseCodeBlockTitle, parseLanguage, parseLines, } from './utils/codeBlockUtils';
+export { docVersionSearchTag, DEFAULT_SEARCH_TAG, useContextualSearchFilters, } from './utils/searchUtils';
+export { isDocsPluginEnabled, useDocById, findSidebarCategory, findFirstCategoryLink, useCurrentSidebarCategory, isActiveSidebarItem, useSidebarBreadcrumbs, } from './utils/docsUtils';
 export { useTitleFormatter } from './utils/generalUtils';
 export { usePluralForm } from './utils/usePluralForm';
-export { useChangeRoute } from './utils/useChangeRoute';
-export { useDocsPreferredVersion, useDocsPreferredVersionByPluginId, } from './utils/docsPreferredVersion/useDocsPreferredVersion';
-export { DocsPreferredVersionContextProvider } from './utils/docsPreferredVersion/DocsPreferredVersionProvider';
+export { useLocationChange } from './utils/useLocationChange';
+export { useCollapsible, Collapsible } from './components/Collapsible';
+export { Details } from './components/Details';
+export { useDocsPreferredVersion, useDocsPreferredVersionByPluginId, DocsPreferredVersionContextProvider, } from './contexts/docsPreferredVersion';
+export { duplicates, uniq } from './utils/jsUtils';
 export { ThemeClassNames } from './utils/ThemeClassNames';
+export { AnnouncementBarProvider, useAnnouncementBar, } from './contexts/announcementBar';
+export { useLocalPathname } from './utils/useLocalPathname';
+export { translateTagsPageTitle, listTagsByLetters, } from './utils/tagsUtils';
+export { useHistoryPopHandler } from './utils/historyUtils';
+export { useTOCHighlight, } from './hooks/useTOCHighlight';
+export { useFilteredAndTreeifiedTOC, useTreeifiedTOC, } from './utils/tocUtils';
+export { isMultiColumnFooterLinks } from './utils/footerUtils';
+export { ScrollControllerProvider, useScrollController, useScrollPosition, useScrollPositionBlocker, } from './utils/scrollUtils';
+export { useIsomorphicLayoutEffect, useDynamicCallback, usePrevious, ReactContextError, } from './utils/reactUtils';
+export { isRegexpStringMatch } from './utils/regexpUtils';
+export { useHomePageRoute, isSamePath } from './utils/routesUtils';
+export { PageMetadata, HtmlClassNameProvider, PluginHtmlClassNameProvider, } from './utils/metadataUtils';
+export { useColorMode, ColorModeProvider, } from './contexts/colorMode';
+export { splitNavbarItems, NavbarProvider } from './utils/navbarUtils';
+export { useTabGroupChoice, TabGroupChoiceProvider, } from './contexts/tabGroupChoice';
+export { useNavbarMobileSidebar } from './contexts/navbarMobileSidebar';
+export { useNavbarSecondaryMenu, NavbarSecondaryMenuFiller, } from './contexts/navbarSecondaryMenu';
+export { useHideableNavbar } from './hooks/useHideableNavbar';
+export { useKeyboardNavigation, keyboardFocusedClassName, } from './hooks/useKeyboardNavigation';
+export { usePrismTheme } from './hooks/usePrismTheme';
+export { useLockBodyScroll } from './hooks/useLockBodyScroll';
+export { useWindowSize } from './hooks/useWindowSize';
+export { useSearchPage } from './hooks/useSearchPage';
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,cAAc,GAYf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EACL,oCAAoC,EACpC,+BAA+B,GAChC,MAAM,yCAAyC,CAAC;AACjD,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAC3E,OAAO,EAAC,mBAAmB,EAAE,cAAc,EAAC,MAAM,wBAAwB,CAAC;AAE3E,OAAO,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AAExE,OAAO,EAAC,qBAAqB,EAAC,MAAM,+BAA+B,CAAC;AAEpE,OAAO,EACL,mBAAmB,EACnB,aAAa,EACb,UAAU,GACX,MAAM,wBAAwB,CAAC;AAEhC,OAAO,EACL,mBAAmB,EACnB,kBAAkB,EAClB,0BAA0B,GAC3B,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,mBAAmB,EACnB,UAAU,EACV,mBAAmB,EACnB,qBAAqB,EACrB,yBAAyB,EACzB,mBAAmB,EACnB,qBAAqB,GACtB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,iBAAiB,EAAC,MAAM,sBAAsB,CAAC;AAEvD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AAEpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAE5D,OAAO,EAAC,cAAc,EAAE,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErE,OAAO,EAAC,OAAO,EAAoB,MAAM,sBAAsB,CAAC;AAEhE,OAAO,EACL,uBAAuB,EACvB,iCAAiC,EACjC,mCAAmC,GACpC,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAC,UAAU,EAAE,IAAI,EAAC,MAAM,iBAAiB,CAAC;AAEjD,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAC;AAExD,OAAO,EACL,uBAAuB,EACvB,kBAAkB,GACnB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAC,gBAAgB,EAAC,MAAM,0BAA0B,CAAC;AAE1D,OAAO,EACL,sBAAsB,EACtB,iBAAiB,GAGlB,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAC,oBAAoB,EAAC,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EACL,eAAe,GAEhB,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACL,0BAA0B,EAC1B,eAAe,GAEhB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAC,wBAAwB,EAAC,MAAM,qBAAqB,CAAC;AAE7D,OAAO,EACL,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,EACjB,wBAAwB,GACzB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACL,yBAAyB,EACzB,kBAAkB,EAClB,WAAW,EACX,iBAAiB,GAClB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EAAC,mBAAmB,EAAC,MAAM,qBAAqB,CAAC;AAExD,OAAO,EAAC,gBAAgB,EAAE,UAAU,EAAC,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EACL,YAAY,EACZ,qBAAqB,EACrB,2BAA2B,GAC5B,MAAM,uBAAuB,CAAC;AAE/B,OAAO,EACL,YAAY,EACZ,iBAAiB,GAElB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAC,gBAAgB,EAAE,cAAc,EAAC,MAAM,qBAAqB,CAAC;AAErE,OAAO,EACL,iBAAiB,EACjB,sBAAsB,GACvB,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EAAC,sBAAsB,EAAC,MAAM,gCAAgC,CAAC;AACtE,OAAO,EACL,sBAAsB,EACtB,yBAAyB,GAE1B,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EACL,qBAAqB,EACrB,wBAAwB,GACzB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAC,iBAAiB,EAAC,MAAM,2BAA2B,CAAC;AAC5D,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAC,aAAa,EAAC,MAAM,uBAAuB,CAAC"}

package/lib/utils/ThemeClassNames.d.ts

@@ -4,19 +4,54 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+/**
+ * These class names are used to style page layouts in Docusaurus, meant to be
+ * targeted by user-provided custom CSS selectors.
+ */
 export declare const ThemeClassNames: {
-    page: {
-        blogListPage: string;
-        blogPostPage: string;
-        blogTagsListPage: string;
-        blogTagsPostPage: string;
-        docPage: string;
-        mdxPage: string;
+    readonly page: {
+        readonly blogListPage: "blog-list-page";
+        readonly blogPostPage: "blog-post-page";
+        readonly blogTagsListPage: "blog-tags-list-page";
+        readonly blogTagPostListPage: "blog-tags-post-list-page";
+        readonly docsDocPage: "docs-doc-page";
+        readonly docsTagsListPage: "docs-tags-list-page";
+        readonly docsTagDocListPage: "docs-tags-doc-list-page";
+        readonly mdxPage: "mdx-page";
+    };
+    readonly wrapper: {
+        readonly main: "main-wrapper";
+        readonly blogPages: "blog-wrapper";
+        readonly docsPages: "docs-wrapper";
+        readonly mdxPages: "mdx-wrapper";
+    };
+    /**
+     * Follows the naming convention "theme-{blog,doc,version,page}?-<suffix>"
+     */
+    readonly common: {
+        readonly editThisPage: "theme-edit-this-page";
+        readonly lastUpdated: "theme-last-updated";
+        readonly backToTopButton: "theme-back-to-top-button";
+        readonly codeBlock: "theme-code-block";
     };
-    wrapper: {
-        main: string;
-        blogPages: string;
-        docPages: string;
-        mdxPages: string;
+    readonly layout: {};
+    readonly docs: {
+        readonly docVersionBanner: "theme-doc-version-banner";
+        readonly docVersionBadge: "theme-doc-version-badge";
+        readonly docBreadcrumbs: "theme-doc-breadcrumbs";
+        readonly docMarkdown: "theme-doc-markdown";
+        readonly docTocMobile: "theme-doc-toc-mobile";
+        readonly docTocDesktop: "theme-doc-toc-desktop";
+        readonly docFooter: "theme-doc-footer";
+        readonly docFooterTagsRow: "theme-doc-footer-tags-row";
+        readonly docFooterEditMetaRow: "theme-doc-footer-edit-meta-row";
+        readonly docSidebarContainer: "theme-doc-sidebar-container";
+        readonly docSidebarMenu: "theme-doc-sidebar-menu";
+        readonly docSidebarItemCategory: "theme-doc-sidebar-item-category";
+        readonly docSidebarItemLink: "theme-doc-sidebar-item-link";
+        readonly docSidebarItemCategoryLevel: (level: number) => `theme-doc-sidebar-item-category-level-${number}`;
+        readonly docSidebarItemLinkLevel: (level: number) => `theme-doc-sidebar-item-link-level-${number}`;
     };
+    readonly blog: {};
 };
+//# sourceMappingURL=ThemeClassNames.d.ts.map

package/lib/utils/ThemeClassNames.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThemeClassNames.d.ts","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;IAoB1B;;OAEG;;;;;;;;;;;;;;;;;;;;;;sDAwBoC,MAAM;kDAEV,MAAM;;;CAOjC,CAAC"}

package/lib/utils/ThemeClassNames.js

@@ -4,20 +4,61 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-// These class names are used to style page layouts in Docusaurus
+// Please do not modify the classnames! This is a breaking change, and annoying
+// for users!
+/**
+ * These class names are used to style page layouts in Docusaurus, meant to be
+ * targeted by user-provided custom CSS selectors.
+ */
 export const ThemeClassNames = {
     page: {
         blogListPage: 'blog-list-page',
         blogPostPage: 'blog-post-page',
         blogTagsListPage: 'blog-tags-list-page',
-        blogTagsPostPage: 'blog-tags-post-page',
-        docPage: 'doc-page',
+        blogTagPostListPage: 'blog-tags-post-list-page',
+        docsDocPage: 'docs-doc-page',
+        docsTagsListPage: 'docs-tags-list-page',
+        docsTagDocListPage: 'docs-tags-doc-list-page',
         mdxPage: 'mdx-page',
     },
     wrapper: {
         main: 'main-wrapper',
         blogPages: 'blog-wrapper',
-        docPages: 'docs-wrapper',
+        docsPages: 'docs-wrapper',
         mdxPages: 'mdx-wrapper',
     },
+    /**
+     * Follows the naming convention "theme-{blog,doc,version,page}?-<suffix>"
+     */
+    common: {
+        editThisPage: 'theme-edit-this-page',
+        lastUpdated: 'theme-last-updated',
+        backToTopButton: 'theme-back-to-top-button',
+        codeBlock: 'theme-code-block',
+    },
+    layout: {
+    // TODO add other stable classNames here
+    },
+    docs: {
+        docVersionBanner: 'theme-doc-version-banner',
+        docVersionBadge: 'theme-doc-version-badge',
+        docBreadcrumbs: 'theme-doc-breadcrumbs',
+        docMarkdown: 'theme-doc-markdown',
+        docTocMobile: 'theme-doc-toc-mobile',
+        docTocDesktop: 'theme-doc-toc-desktop',
+        docFooter: 'theme-doc-footer',
+        docFooterTagsRow: 'theme-doc-footer-tags-row',
+        docFooterEditMetaRow: 'theme-doc-footer-edit-meta-row',
+        docSidebarContainer: 'theme-doc-sidebar-container',
+        docSidebarMenu: 'theme-doc-sidebar-menu',
+        docSidebarItemCategory: 'theme-doc-sidebar-item-category',
+        docSidebarItemLink: 'theme-doc-sidebar-item-link',
+        docSidebarItemCategoryLevel: (level) => `theme-doc-sidebar-item-category-level-${level}`,
+        docSidebarItemLinkLevel: (level) => `theme-doc-sidebar-item-link-level-${level}`,
+        // TODO add other stable classNames here
+    },
+    blog: {
+    // TODO add other stable classNames here
+    },
 };
+//# sourceMappingURL=ThemeClassNames.js.map

package/lib/utils/ThemeClassNames.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ThemeClassNames.js","sourceRoot":"","sources":["../../src/utils/ThemeClassNames.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,+EAA+E;AAC/E,aAAa;AAEb;;;GAGG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,IAAI,EAAE;QACJ,YAAY,EAAE,gBAAgB;QAC9B,YAAY,EAAE,gBAAgB;QAC9B,gBAAgB,EAAE,qBAAqB;QACvC,mBAAmB,EAAE,0BAA0B;QAE/C,WAAW,EAAE,eAAe;QAC5B,gBAAgB,EAAE,qBAAqB;QACvC,kBAAkB,EAAE,yBAAyB;QAE7C,OAAO,EAAE,UAAU;KACpB;IACD,OAAO,EAAE;QACP,IAAI,EAAE,cAAc;QACpB,SAAS,EAAE,cAAc;QACzB,SAAS,EAAE,cAAc;QACzB,QAAQ,EAAE,aAAa;KACxB;IAED;;OAEG;IACH,MAAM,EAAE;QACN,YAAY,EAAE,sBAAsB;QACpC,WAAW,EAAE,oBAAoB;QACjC,eAAe,EAAE,0BAA0B;QAC3C,SAAS,EAAE,kBAAkB;KAC9B;IACD,MAAM,EAAE;IACN,wCAAwC;KACzC;IACD,IAAI,EAAE;QACJ,gBAAgB,EAAE,0BAA0B;QAC5C,eAAe,EAAE,yBAAyB;QAC1C,cAAc,EAAE,uBAAuB;QACvC,WAAW,EAAE,oBAAoB;QACjC,YAAY,EAAE,sBAAsB;QACpC,aAAa,EAAE,uBAAuB;QACtC,SAAS,EAAE,kBAAkB;QAC7B,gBAAgB,EAAE,2BAA2B;QAC7C,oBAAoB,EAAE,gCAAgC;QACtD,mBAAmB,EAAE,6BAA6B;QAClD,cAAc,EAAE,wBAAwB;QACxC,sBAAsB,EAAE,iCAAiC;QACzD,kBAAkB,EAAE,6BAA6B;QACjD,2BAA2B,EAAE,CAAC,KAAa,EAAE,EAAE,CAC7C,yCAAyC,KAAK,EAAW;QAC3D,uBAAuB,EAAE,CAAC,KAAa,EAAE,EAAE,CACzC,qCAAqC,KAAK,EAAW;QACvD,wCAAwC;KACzC;IACD,IAAI,EAAE;IACJ,wCAAwC;KACzC;CACO,CAAC"}

package/lib/utils/codeBlockUtils.d.ts

@@ -5,3 +5,36 @@
  * LICENSE file in the root directory of this source tree.
  */
 export declare function parseCodeBlockTitle(metastring?: string): string;
+/**
+ * Gets the language name from the class name (set by MDX).
+ * e.g. `"language-javascript"` => `"javascript"`.
+ * Returns undefined if there is no language class name.
+ */
+export declare function parseLanguage(className: string): string | undefined;
+/**
+ * Parses the code content, strips away any magic comments, and returns the
+ * clean content and the highlighted lines marked by the comments or metastring.
+ *
+ * If the metastring contains highlight range, the `content` will be returned
+ * as-is without any parsing.
+ *
+ * @param content The raw code with magic comments. Trailing newline will be
+ * trimmed upfront.
+ * @param metastring The full metastring, as received from MDX. Highlight range
+ * declared here starts at 1.
+ * @param language Language of the code block, used to determine which kinds of
+ * magic comment styles to enable.
+ */
+export declare function parseLines(content: string, metastring?: string, language?: string): {
+    /**
+     * The highlighted lines, 0-indexed. e.g. `[0, 1, 4]` means the 1st, 2nd, and
+     * 5th lines are highlighted.
+     */
+    highlightLines: number[];
+    /**
+     * The clean code without any magic comments (only if highlight range isn't
+     * present in the metastring).
+     */
+    code: string;
+};
+//# sourceMappingURL=codeBlockUtils.d.ts.map

package/lib/utils/codeBlockUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"codeBlockUtils.d.ts","sourceRoot":"","sources":["../../src/utils/codeBlockUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAgEH,wBAAgB,mBAAmB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,MAAM,CAE/D;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAKnE;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,UAAU,CACxB,OAAO,EAAE,MAAM,EACf,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,GAChB;IACD;;;OAGG;IACH,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAkDA"}

package/lib/utils/codeBlockUtils.js

@@ -4,8 +4,131 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-const codeBlockTitleRegex = /title=(["'])(.*?)\1/;
+import rangeParser from 'parse-numeric-range';
+const codeBlockTitleRegex = /title=(?<quote>["'])(?<title>.*?)\1/;
+const highlightLinesRangeRegex = /\{(?<range>[\d,-]+)\}/;
+// Supported types of highlight comments
+const commentPatterns = {
+    js: { start: '\\/\\/', end: '' },
+    jsBlock: { start: '\\/\\*', end: '\\*\\/' },
+    jsx: { start: '\\{\\s*\\/\\*', end: '\\*\\/\\s*\\}' },
+    python: { start: '#', end: '' },
+    html: { start: '<!--', end: '-->' },
+};
+const magicCommentDirectives = [
+    'highlight-next-line',
+    'highlight-start',
+    'highlight-end',
+];
+function getCommentPattern(languages) {
+    // to be more reliable, the opening and closing comment must match
+    const commentPattern = languages
+        .map((lang) => {
+        const { start, end } = commentPatterns[lang];
+        return `(?:${start}\\s*(${magicCommentDirectives.join('|')})\\s*${end})`;
+    })
+        .join('|');
+    // white space is allowed, but otherwise it should be on it's own line
+    return new RegExp(`^\\s*(?:${commentPattern})\\s*$`);
+}
+/**
+ * Select comment styles based on language
+ */
+function getAllMagicCommentDirectiveStyles(lang) {
+    switch (lang) {
+        case 'js':
+        case 'javascript':
+        case 'ts':
+        case 'typescript':
+            return getCommentPattern(['js', 'jsBlock']);
+        case 'jsx':
+        case 'tsx':
+            return getCommentPattern(['js', 'jsBlock', 'jsx']);
+        case 'html':
+            return getCommentPattern(['js', 'jsBlock', 'html']);
+        case 'python':
+        case 'py':
+            return getCommentPattern(['python']);
+        default:
+            // all comment types
+            return getCommentPattern(Object.keys(commentPatterns));
+    }
+}
 export function parseCodeBlockTitle(metastring) {
-    var _a, _b;
-    return (_b = (_a = metastring === null || metastring === void 0 ? void 0 : metastring.match(codeBlockTitleRegex)) === null || _a === void 0 ? void 0 : _a[2]) !== null && _b !== void 0 ? _b : '';
+    return metastring?.match(codeBlockTitleRegex)?.groups.title ?? '';
+}
+/**
+ * Gets the language name from the class name (set by MDX).
+ * e.g. `"language-javascript"` => `"javascript"`.
+ * Returns undefined if there is no language class name.
+ */
+export function parseLanguage(className) {
+    const languageClassName = className
+        .split(' ')
+        .find((str) => str.startsWith('language-'));
+    return languageClassName?.replace(/language-/, '');
+}
+/**
+ * Parses the code content, strips away any magic comments, and returns the
+ * clean content and the highlighted lines marked by the comments or metastring.
+ *
+ * If the metastring contains highlight range, the `content` will be returned
+ * as-is without any parsing.
+ *
+ * @param content The raw code with magic comments. Trailing newline will be
+ * trimmed upfront.
+ * @param metastring The full metastring, as received from MDX. Highlight range
+ * declared here starts at 1.
+ * @param language Language of the code block, used to determine which kinds of
+ * magic comment styles to enable.
+ */
+export function parseLines(content, metastring, language) {
+    let code = content.replace(/\n$/, '');
+    // Highlighted lines specified in props: don't parse the content
+    if (metastring && highlightLinesRangeRegex.test(metastring)) {
+        const highlightLinesRange = metastring.match(highlightLinesRangeRegex)
+            .groups.range;
+        const highlightLines = rangeParser(highlightLinesRange)
+            .filter((n) => n > 0)
+            .map((n) => n - 1);
+        return { highlightLines, code };
+    }
+    if (language === undefined) {
+        return { highlightLines: [], code };
+    }
+    const directiveRegex = getAllMagicCommentDirectiveStyles(language);
+    // go through line by line
+    const lines = code.split('\n');
+    let highlightBlockStart;
+    let highlightRange = '';
+    // loop through lines
+    for (let lineNumber = 0; lineNumber < lines.length;) {
+        const line = lines[lineNumber];
+        const match = line.match(directiveRegex);
+        if (match !== null) {
+            const directive = match.slice(1).find((item) => item !== undefined);
+            switch (directive) {
+                case 'highlight-next-line':
+                    highlightRange += `${lineNumber},`;
+                    break;
+                case 'highlight-start':
+                    highlightBlockStart = lineNumber;
+                    break;
+                case 'highlight-end':
+                    highlightRange += `${highlightBlockStart}-${lineNumber - 1},`;
+                    break;
+                default:
+                    break;
+            }
+            lines.splice(lineNumber, 1);
+        }
+        else {
+            // lines without directives are unchanged
+            lineNumber += 1;
+        }
+    }
+    const highlightLines = rangeParser(highlightRange);
+    code = lines.join('\n');
+    return { highlightLines, code };
 }
+//# sourceMappingURL=codeBlockUtils.js.map

package/lib/utils/codeBlockUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"codeBlockUtils.js","sourceRoot":"","sources":["../../src/utils/codeBlockUtils.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,WAAW,MAAM,qBAAqB,CAAC;AAE9C,MAAM,mBAAmB,GAAG,qCAAqC,CAAC;AAClE,MAAM,wBAAwB,GAAG,uBAAuB,CAAC;AAEzD,wCAAwC;AACxC,MAAM,eAAe,GAAG;IACtB,EAAE,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,EAAC;IAC9B,OAAO,EAAE,EAAC,KAAK,EAAE,QAAQ,EAAE,GAAG,EAAE,QAAQ,EAAC;IACzC,GAAG,EAAE,EAAC,KAAK,EAAE,eAAe,EAAE,GAAG,EAAE,eAAe,EAAC;IACnD,MAAM,EAAE,EAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAC;IAC7B,IAAI,EAAE,EAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,KAAK,EAAC;CAClC,CAAC;AAIF,MAAM,sBAAsB,GAAG;IAC7B,qBAAqB;IACrB,iBAAiB;IACjB,eAAe;CAChB,CAAC;AAEF,SAAS,iBAAiB,CAAC,SAAwB;IACjD,kEAAkE;IAClE,MAAM,cAAc,GAAG,SAAS;SAC7B,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACZ,MAAM,EAAC,KAAK,EAAE,GAAG,EAAC,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;QAC3C,OAAO,MAAM,KAAK,QAAQ,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC;IAC3E,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,sEAAsE;IACtE,OAAO,IAAI,MAAM,CAAC,WAAW,cAAc,QAAQ,CAAC,CAAC;AACvD,CAAC;AAED;;GAEG;AACH,SAAS,iCAAiC,CAAC,IAAY;IACrD,QAAQ,IAAI,EAAE;QACZ,KAAK,IAAI,CAAC;QACV,KAAK,YAAY,CAAC;QAClB,KAAK,IAAI,CAAC;QACV,KAAK,YAAY;YACf,OAAO,iBAAiB,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,CAAC;QAE9C,KAAK,KAAK,CAAC;QACX,KAAK,KAAK;YACR,OAAO,iBAAiB,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QAErD,KAAK,MAAM;YACT,OAAO,iBAAiB,CAAC,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QAEtD,KAAK,QAAQ,CAAC;QACd,KAAK,IAAI;YACP,OAAO,iBAAiB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAEvC;YACE,oBAAoB;YACpB,OAAO,iBAAiB,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,CAAkB,CAAC,CAAC;KAC3E;AACH,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,UAAmB;IACrD,OAAO,UAAU,EAAE,KAAK,CAAC,mBAAmB,CAAC,EAAE,MAAO,CAAC,KAAK,IAAI,EAAE,CAAC;AACrE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,SAAiB;IAC7C,MAAM,iBAAiB,GAAG,SAAS;SAChC,KAAK,CAAC,GAAG,CAAC;SACV,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC;IAC9C,OAAO,iBAAiB,EAAE,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;AACrD,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,UAAU,CACxB,OAAe,EACf,UAAmB,EACnB,QAAiB;IAajB,IAAI,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;IACtC,gEAAgE;IAChE,IAAI,UAAU,IAAI,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE;QAC3D,MAAM,mBAAmB,GAAG,UAAU,CAAC,KAAK,CAAC,wBAAwB,CAAE;aACpE,MAAO,CAAC,KAAM,CAAC;QAClB,MAAM,cAAc,GAAG,WAAW,CAAC,mBAAmB,CAAC;aACpD,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC;aACpB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;QACrB,OAAO,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC;KAC/B;IACD,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,OAAO,EAAC,cAAc,EAAE,EAAE,EAAE,IAAI,EAAC,CAAC;KACnC;IACD,MAAM,cAAc,GAAG,iCAAiC,CAAC,QAAQ,CAAC,CAAC;IACnE,0BAA0B;IAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,mBAA2B,CAAC;IAChC,IAAI,cAAc,GAAG,EAAE,CAAC;IACxB,qBAAqB;IACrB,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,KAAK,CAAC,MAAM,GAAI;QACpD,MAAM,IAAI,GAAG,KAAK,CAAC,UAAU,CAAE,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QACzC,IAAI,KAAK,KAAK,IAAI,EAAE;YAClB,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;YACpE,QAAQ,SAAS,EAAE;gBACjB,KAAK,qBAAqB;oBACxB,cAAc,IAAI,GAAG,UAAU,GAAG,CAAC;oBACnC,MAAM;gBAER,KAAK,iBAAiB;oBACpB,mBAAmB,GAAG,UAAU,CAAC;oBACjC,MAAM;gBAER,KAAK,eAAe;oBAClB,cAAc,IAAI,GAAG,mBAAoB,IAAI,UAAU,GAAG,CAAC,GAAG,CAAC;oBAC/D,MAAM;gBAER;oBACE,MAAM;aACT;YACD,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC;SAC7B;aAAM;YACL,yCAAyC;YACzC,UAAU,IAAI,CAAC,CAAC;SACjB;KACF;IACD,MAAM,cAAc,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IACnD,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACxB,OAAO,EAAC,cAAc,EAAE,IAAI,EAAC,CAAC;AAChC,CAAC"}

package/lib/utils/docsUtils.d.ts

@@ -4,4 +4,37 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
+import type { PropSidebar, PropSidebarItem, PropSidebarItemCategory, PropVersionDoc, PropSidebarBreadcrumbsItem } from '@docusaurus/plugin-content-docs';
 export declare const isDocsPluginEnabled: boolean;
+/**
+ * A null-safe way to access a doc's data by ID in the active version.
+ */
+export declare function useDocById(id: string): PropVersionDoc;
+/**
+ * A null-safe way to access a doc's data by ID in the active version.
+ */
+export declare function useDocById(id: string | undefined): PropVersionDoc | undefined;
+/**
+ * Pure function, similar to `Array#find`, but works on the sidebar tree.
+ */
+export declare function findSidebarCategory(sidebar: PropSidebar, predicate: (category: PropSidebarItemCategory) => boolean): PropSidebarItemCategory | undefined;
+/**
+ * Best effort to assign a link to a sidebar category. If the category doesn't
+ * have a link itself, we link to the first sub item with a link.
+ */
+export declare function findFirstCategoryLink(item: PropSidebarItemCategory): string | undefined;
+/**
+ * Gets the category associated with the current location. Should only be used
+ * on category index pages.
+ */
+export declare function useCurrentSidebarCategory(): PropSidebarItemCategory;
+/**
+ * Checks if a sidebar item should be active, based on the active path.
+ */
+export declare function isActiveSidebarItem(item: PropSidebarItem, activePath: string): boolean;
+/**
+ * Gets the breadcrumbs of the current doc page, based on its sidebar location.
+ * Returns `null` if there's no sidebar or breadcrumbs are disabled.
+ */
+export declare function useSidebarBreadcrumbs(): PropSidebarBreadcrumbsItem[] | null;
+//# sourceMappingURL=docsUtils.d.ts.map

package/lib/utils/docsUtils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docsUtils.d.ts","sourceRoot":"","sources":["../../src/utils/docsUtils.tsx"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,OAAO,KAAK,EACV,WAAW,EACX,eAAe,EACf,uBAAuB,EACvB,cAAc,EACd,0BAA0B,EAC3B,MAAM,iCAAiC,CAAC;AAOzC,eAAO,MAAM,mBAAmB,EAAE,OAA0B,CAAC;AAE7D;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,CAAC;AACvD;;GAEG;AACH,wBAAgB,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,SAAS,CAAC;AAa/E;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,WAAW,EACpB,SAAS,EAAE,CAAC,QAAQ,EAAE,uBAAuB,KAAK,OAAO,GACxD,uBAAuB,GAAG,SAAS,CAarC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,uBAAuB,GAC5B,MAAM,GAAG,SAAS,CAsBpB;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,uBAAuB,CAenE;AASD;;GAEG;AACH,wBAAgB,mBAAmB,CACjC,IAAI,EAAE,eAAe,EACrB,UAAU,EAAE,MAAM,GACjB,OAAO,CAaT;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,IAAI,0BAA0B,EAAE,GAAG,IAAI,CA6B3E"}