@docusaurus/theme-classic 2.0.0-beta.15d451942 → 2.0.0-beta.16

package/lib/theme/LayoutHead/index.js

@@ -1,144 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = LayoutHead;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Head = _interopRequireDefault(require("@docusaurus/Head"));
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-var _useBaseUrl = _interopRequireDefault(require("@docusaurus/useBaseUrl"));
-
-var _SearchMetadatas = _interopRequireDefault(require("@theme/SearchMetadatas"));
-
-var _Seo = _interopRequireDefault(require("@theme/Seo"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _router = require("@docusaurus/router");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-// Useful for SEO
-// See https://developers.google.com/search/docs/advanced/crawling/localized-versions
-// See https://github.com/facebook/docusaurus/issues/3317
-function AlternateLangHeaders() {
-  const {
-    i18n: {
-      defaultLocale,
-      locales
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const alternatePageUtils = (0, _themeCommon.useAlternatePageUtils)(); // Note: it is fine to use both "x-default" and "en" to target the same url
-  // See https://www.searchviu.com/en/multiple-hreflang-tags-one-url/
-
-  return <_Head.default>
-      {locales.map(locale => <link key={locale} rel="alternate" href={alternatePageUtils.createUrl({
-      locale,
-      fullyQualified: true
-    })} hrefLang={locale} />)}
-      <link rel="alternate" href={alternatePageUtils.createUrl({
-      locale: defaultLocale,
-      fullyQualified: true
-    })} hrefLang="x-default" />
-    </_Head.default>;
-} // Default canonical url inferred from current page location pathname
-
-
-function useDefaultCanonicalUrl() {
-  const {
-    siteConfig: {
-      url: siteUrl
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    pathname
-  } = (0, _router.useLocation)();
-  return siteUrl + (0, _useBaseUrl.default)(pathname);
-}
-
-function CanonicalUrlHeaders({
-  permalink
-}) {
-  const {
-    siteConfig: {
-      url: siteUrl
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const defaultCanonicalUrl = useDefaultCanonicalUrl();
-  const canonicalUrl = permalink ? `${siteUrl}${permalink}` : defaultCanonicalUrl;
-  return <_Head.default>
-      <meta property="og:url" content={canonicalUrl} />
-      <link rel="canonical" href={canonicalUrl} />
-    </_Head.default>;
-}
-
-function LayoutHead(props) {
-  const {
-    siteConfig: {
-      favicon,
-      themeConfig: {
-        metadatas,
-        image: defaultImage
-      }
-    },
-    i18n: {
-      currentLocale,
-      localeConfigs
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    title,
-    description,
-    image,
-    keywords,
-    searchMetadatas
-  } = props;
-  const faviconUrl = (0, _useBaseUrl.default)(favicon);
-  const pageTitle = (0, _themeCommon.useTitleFormatter)(title); // See https://github.com/facebook/docusaurus/issues/3317#issuecomment-754661855
-  // const htmlLang = currentLocale.split('-')[0];
-
-  const htmlLang = currentLocale; // should we allow the user to override htmlLang with localeConfig?
-
-  const htmlDir = localeConfigs[currentLocale].direction;
-  return <>
-      <_Head.default>
-        <html lang={htmlLang} dir={htmlDir} />
-        {favicon && <link rel="shortcut icon" href={faviconUrl} />}
-        <title>{pageTitle}</title>
-        <meta property="og:title" content={pageTitle} />
-        {image || defaultImage && <meta name="twitter:card" content="summary_large_image" />}
-      </_Head.default>
-
-      <_Seo.default {...{
-      description,
-      keywords,
-      image
-    }} />
-
-      <CanonicalUrlHeaders />
-
-      <AlternateLangHeaders />
-
-      <_SearchMetadatas.default tag={_themeCommon.DEFAULT_SEARCH_TAG} locale={currentLocale} {...searchMetadatas} />
-
-      <_Head.default // it's important to have an additional <Head> element here,
-    // as it allows react-helmet to override values set in previous <Head>
-    // ie we can override default metadatas such as "twitter:card"
-    // In same Head, the same meta would appear twice instead of overriding
-    // See react-helmet doc
-    >
-        {metadatas.map((metadata, i) => <meta key={`metadata_${i}`} {...metadata} />)}
-      </_Head.default>
-    </>;
-}

package/lib/theme/LayoutProviders/index.js

@@ -1,34 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = LayoutProviders;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _ThemeProvider = _interopRequireDefault(require("@theme/ThemeProvider"));
-
-var _UserPreferencesProvider = _interopRequireDefault(require("@theme/UserPreferencesProvider"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-function LayoutProviders({
-  children
-}) {
-  return <_ThemeProvider.default>
-      <_UserPreferencesProvider.default>
-        <_themeCommon.DocsPreferredVersionContextProvider>
-          {children}
-        </_themeCommon.DocsPreferredVersionContextProvider>
-      </_UserPreferencesProvider.default>
-    </_ThemeProvider.default>;
-}

package/lib/theme/Logo/index.js

@@ -1,59 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _ThemedImage = _interopRequireDefault(require("@theme/ThemedImage"));
-
-var _useBaseUrl = _interopRequireDefault(require("@docusaurus/useBaseUrl"));
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-const Logo = props => {
-  const {
-    isClient
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    navbar: {
-      title,
-      logo = {
-        src: ''
-      }
-    }
-  } = (0, _themeCommon.useThemeConfig)();
-  const {
-    imageClassName,
-    titleClassName,
-    ...propsRest
-  } = props;
-  const logoLink = (0, _useBaseUrl.default)(logo.href || '/');
-  const sources = {
-    light: (0, _useBaseUrl.default)(logo.src),
-    dark: (0, _useBaseUrl.default)(logo.srcDark || logo.src)
-  };
-  return <_Link.default to={logoLink} {...propsRest} {...logo.target && {
-    target: logo.target
-  }}>
-      {logo.src && <_ThemedImage.default key={isClient} className={imageClassName} sources={sources} alt={logo.alt || title || 'Logo'} />}
-      {title != null && <strong className={titleClassName}>{title}</strong>}
-    </_Link.default>;
-};
-
-var _default = Logo;
-exports.default = _default;

package/lib/theme/MDXComponents/index.js

@@ -1,65 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _CodeBlock = _interopRequireDefault(require("@theme/CodeBlock"));
-
-var _Heading = _interopRequireDefault(require("@theme/Heading"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-/**
- * 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.
- */
-const MDXComponents = {
-  code: props => {
-    const {
-      children
-    } = props; // For retrocompatibility purposes (pretty rare use case)
-    // See https://github.com/facebook/docusaurus/pull/1584
-
-    if ((0, _react.isValidElement)(children)) {
-      return children;
-    }
-
-    return !children.includes('\n') ? <code {...props} /> : <_CodeBlock.default {...props} />;
-  },
-  a: props => <_Link.default {...props} />,
-  pre: props => {
-    var _children$props;
-
-    const {
-      children
-    } = props; // See comment for `code` above
-
-    if ((0, _react.isValidElement)(children === null || children === void 0 ? void 0 : (_children$props = children.props) === null || _children$props === void 0 ? void 0 : _children$props.children)) {
-      return children === null || children === void 0 ? void 0 : children.props.children;
-    }
-
-    return <_CodeBlock.default {...(0, _react.isValidElement)(children) ? children === null || children === void 0 ? void 0 : children.props : {
-      children
-    }} />;
-  },
-  h1: (0, _Heading.default)('h1'),
-  h2: (0, _Heading.default)('h2'),
-  h3: (0, _Heading.default)('h3'),
-  h4: (0, _Heading.default)('h4'),
-  h5: (0, _Heading.default)('h5'),
-  h6: (0, _Heading.default)('h6')
-};
-var _default = MDXComponents;
-exports.default = _default;

package/lib/theme/MDXPage/index.js

@@ -1,68 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Layout = _interopRequireDefault(require("@theme/Layout"));
-
-var _react2 = require("@mdx-js/react");
-
-var _MDXComponents = _interopRequireDefault(require("@theme/MDXComponents"));
-
-var _TOC = _interopRequireDefault(require("@theme/TOC"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-/**
- * 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.
- */
-function MDXPage(props) {
-  const {
-    content: MDXPageContent
-  } = props;
-  const {
-    frontMatter,
-    metadata
-  } = MDXPageContent;
-  const {
-    title,
-    description,
-    wrapperClassName,
-    hide_table_of_contents: hideTableOfContents
-  } = frontMatter;
-  const {
-    permalink
-  } = metadata;
-  return <_Layout.default title={title} description={description} permalink={permalink} wrapperClassName={wrapperClassName !== null && wrapperClassName !== void 0 ? wrapperClassName : _themeCommon.ThemeClassNames.wrapper.mdxPages} pageClassName={_themeCommon.ThemeClassNames.page.mdxPage}>
-      <main>
-        <div className="container container--fluid">
-          <div className="margin-vert--lg padding-vert--lg">
-            <div className="row">
-              <div className="col col--8 col--offset-2">
-                <div className="container">
-                  <_react2.MDXProvider components={_MDXComponents.default}>
-                    <MDXPageContent />
-                  </_react2.MDXProvider>
-                </div>
-              </div>
-              {!hideTableOfContents && MDXPageContent.toc && <div className="col col--2">
-                  <_TOC.default toc={MDXPageContent.toc} />
-                </div>}
-            </div>
-          </div>
-        </div>
-      </main>
-    </_Layout.default>;
-}
-
-var _default = MDXPage;
-exports.default = _default;

package/lib/theme/Navbar/index.js

@@ -1,147 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _SearchBar = _interopRequireDefault(require("@theme/SearchBar"));
-
-var _Toggle = _interopRequireDefault(require("@theme/Toggle"));
-
-var _useThemeContext = _interopRequireDefault(require("@theme/hooks/useThemeContext"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _useHideableNavbar = _interopRequireDefault(require("@theme/hooks/useHideableNavbar"));
-
-var _useLockBodyScroll = _interopRequireDefault(require("@theme/hooks/useLockBodyScroll"));
-
-var _useWindowSize = _interopRequireWildcard(require("@theme/hooks/useWindowSize"));
-
-var _NavbarItem = _interopRequireDefault(require("@theme/NavbarItem"));
-
-var _Logo = _interopRequireDefault(require("@theme/Logo"));
-
-var _IconMenu = _interopRequireDefault(require("@theme/IconMenu"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
-
-function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-
-/**
- * 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.
- */
-// retrocompatible with v1
-const DefaultNavItemPosition = 'right'; // If split links by left/right
-// if position is unspecified, fallback to right (as v1)
-
-function splitNavItemsByPosition(items) {
-  const leftItems = items.filter(item => {
-    var _item$position;
-
-    return ((_item$position = item.position) !== null && _item$position !== void 0 ? _item$position : DefaultNavItemPosition) === 'left';
-  });
-  const rightItems = items.filter(item => {
-    var _item$position2;
-
-    return ((_item$position2 = item.position) !== null && _item$position2 !== void 0 ? _item$position2 : DefaultNavItemPosition) === 'right';
-  });
-  return {
-    leftItems,
-    rightItems
-  };
-}
-
-function Navbar() {
-  const {
-    navbar: {
-      items,
-      hideOnScroll,
-      style
-    },
-    colorMode: {
-      disableSwitch: disableColorModeSwitch
-    }
-  } = (0, _themeCommon.useThemeConfig)();
-  const [sidebarShown, setSidebarShown] = (0, _react.useState)(false);
-  const {
-    isDarkTheme,
-    setLightTheme,
-    setDarkTheme
-  } = (0, _useThemeContext.default)();
-  const {
-    navbarRef,
-    isNavbarVisible
-  } = (0, _useHideableNavbar.default)(hideOnScroll);
-  (0, _useLockBodyScroll.default)(sidebarShown);
-  const showSidebar = (0, _react.useCallback)(() => {
-    setSidebarShown(true);
-  }, [setSidebarShown]);
-  const hideSidebar = (0, _react.useCallback)(() => {
-    setSidebarShown(false);
-  }, [setSidebarShown]);
-  const onToggleChange = (0, _react.useCallback)(e => e.target.checked ? setDarkTheme() : setLightTheme(), [setLightTheme, setDarkTheme]);
-  const windowSize = (0, _useWindowSize.default)();
-  (0, _react.useEffect)(() => {
-    if (windowSize === _useWindowSize.windowSizes.desktop) {
-      setSidebarShown(false);
-    }
-  }, [windowSize]);
-  const hasSearchNavbarItem = items.some(item => item.type === 'search');
-  const {
-    leftItems,
-    rightItems
-  } = splitNavItemsByPosition(items);
-  return <nav ref={navbarRef} className={(0, _clsx.default)('navbar', 'navbar--fixed-top', {
-    'navbar--dark': style === 'dark',
-    'navbar--primary': style === 'primary',
-    'navbar-sidebar--show': sidebarShown,
-    [_stylesModule.default.navbarHideable]: hideOnScroll,
-    [_stylesModule.default.navbarHidden]: hideOnScroll && !isNavbarVisible
-  })}>
-      <div className="navbar__inner">
-        <div className="navbar__items">
-          {items != null && items.length !== 0 && <button aria-label="Navigation bar toggle" className="navbar__toggle" type="button" tabIndex={0} onClick={showSidebar} onKeyDown={showSidebar}>
-              <_IconMenu.default />
-            </button>}
-          <_Logo.default className="navbar__brand" imageClassName="navbar__logo" titleClassName={(0, _clsx.default)('navbar__title')} />
-          {leftItems.map((item, i) => <_NavbarItem.default {...item} key={i} />)}
-        </div>
-        <div className="navbar__items navbar__items--right">
-          {rightItems.map((item, i) => <_NavbarItem.default {...item} key={i} />)}
-          {!disableColorModeSwitch && <_Toggle.default className={_stylesModule.default.displayOnlyInLargeViewport} checked={isDarkTheme} onChange={onToggleChange} />}
-          {!hasSearchNavbarItem && <_SearchBar.default />}
-        </div>
-      </div>
-      <div role="presentation" className="navbar-sidebar__backdrop" onClick={hideSidebar} />
-      <div className="navbar-sidebar">
-        <div className="navbar-sidebar__brand">
-          <_Logo.default className="navbar__brand" imageClassName="navbar__logo" titleClassName="navbar__title" onClick={hideSidebar} />
-          {!disableColorModeSwitch && sidebarShown && <_Toggle.default checked={isDarkTheme} onChange={onToggleChange} />}
-        </div>
-        <div className="navbar-sidebar__items">
-          <div className="menu">
-            <ul className="menu__list">
-              {items.map((item, i) => <_NavbarItem.default mobile {...item} // TODO fix typing
-            onClick={hideSidebar} key={i} />)}
-            </ul>
-          </div>
-        </div>
-      </div>
-    </nav>;
-}
-
-var _default = Navbar;
-exports.default = _default;

package/lib/theme/Navbar/styles.module.css

@@ -1,20 +0,0 @@
-/**
- * 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.
- */
-
-@media screen and (max-width: 997px) {
-  .displayOnlyInLargeViewport {
-    display: none !important;
-  }
-}
-
-.navbarHideable {
-  transition: transform var(--ifm-transition-fast) ease;
-}
-
-.navbarHidden {
-  transform: translate3d(0, calc(var(--ifm-navbar-height) * -1), 0);
-}