@docusaurus/theme-classic 2.0.0-beta.13 → 2.0.0-beta.15

package/lib/theme/LayoutHead/index.js

@@ -1,149 +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 _SearchMetadata = _interopRequireDefault(require("@theme/SearchMetadata"));
-
-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
-    },
-    i18n: {
-      currentLocale,
-      localeConfigs
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    metadata,
-    image: defaultImage
-  } = (0, _themeCommon.useThemeConfig)();
-  const {
-    title,
-    description,
-    image,
-    keywords,
-    searchMetadata
-  } = 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="icon" href={faviconUrl} />}
-        <title>{pageTitle}</title>
-        <meta property="og:title" content={pageTitle} />
-        <meta name="twitter:card" content="summary_large_image" />
-      </_Head.default>
-
-      {
-      /* image can override the default image */
-    }
-      {defaultImage && <_Seo.default image={defaultImage} />}
-      {image && <_Seo.default image={image} />}
-
-      <_Seo.default description={description} keywords={keywords} />
-
-      <CanonicalUrlHeaders />
-
-      <AlternateLangHeaders />
-
-      <_SearchMetadata.default tag={_themeCommon.DEFAULT_SEARCH_TAG} locale={currentLocale} {...searchMetadata} />
-
-      <_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 metadata such as "twitter:card"
-    // In same Head, the same meta would appear twice instead of overriding
-    // See react-helmet doc
-    >
-        {
-        /* Yes, "metadatum" is the grammatically correct term */
-      }
-        {metadata.map((metadatum, i) => <meta key={`metadata_${i}`} {...metadatum} />)}
-      </_Head.default>
-    </>;
-}

package/lib/theme/LayoutProviders/index.js

@@ -1,40 +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>
-      <_themeCommon.AnnouncementBarProvider>
-        <_UserPreferencesProvider.default>
-          <_themeCommon.ScrollControllerProvider>
-            <_themeCommon.DocsPreferredVersionContextProvider>
-              <_themeCommon.MobileSecondaryMenuProvider>
-                {children}
-              </_themeCommon.MobileSecondaryMenuProvider>
-            </_themeCommon.DocsPreferredVersionContextProvider>
-          </_themeCommon.ScrollControllerProvider>
-        </_UserPreferencesProvider.default>
-      </_themeCommon.AnnouncementBarProvider>
-    </_ThemeProvider.default>;
-}

package/lib/theme/Logo/index.js

@@ -1,62 +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.
- */
-function Logo(props) {
-  const {
-    siteConfig: {
-      title
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    navbar: {
-      title: navbarTitle,
-      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)
-  };
-  const themedImage = <_ThemedImage.default sources={sources} height={logo.height} width={logo.width} alt={logo.alt || navbarTitle || title} />;
-  return <_Link.default to={logoLink} {...propsRest} {...logo.target && {
-    target: logo.target
-  }}>
-      {logo.src && (imageClassName ? <div className={imageClassName}>{themedImage}</div> : themedImage)}
-      {navbarTitle != null && <b className={titleClassName}>{navbarTitle}</b>}
-    </_Link.default>;
-}
-
-var _default = Logo;
-exports.default = _default;

package/lib/theme/MDXComponents/index.js

@@ -1,106 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _Head = _interopRequireDefault(require("@docusaurus/Head"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _CodeBlock = _interopRequireDefault(require("@theme/CodeBlock"));
-
-var _Heading = _interopRequireDefault(require("@theme/Heading"));
-
-var _Details = _interopRequireDefault(require("@theme/Details"));
-
-require("./styles.css");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
-
-function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && 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.
- */
-// MDX elements are wrapped through the MDX pragma
-// In some cases (notably usage with Head/Helmet) we need to unwrap those elements.
-function unwrapMDXElement(element) {
-  var _element$props, _element$props2;
-
-  if (element !== null && element !== void 0 && (_element$props = element.props) !== null && _element$props !== void 0 && _element$props.mdxType && element !== null && element !== void 0 && (_element$props2 = element.props) !== null && _element$props2 !== void 0 && _element$props2.originalType) {
-    const {
-      mdxType,
-      originalType,
-      ...newProps
-    } = element.props;
-    return _react.default.createElement(element.props.originalType, newProps);
-  }
-
-  return element;
-}
-
-const MDXComponents = {
-  head: props => {
-    const unwrappedChildren = _react.default.Children.map(props.children, child => unwrapMDXElement(child));
-
-    return <_Head.default {...props}>{unwrappedChildren}</_Head.default>;
-  },
-  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) && (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.props.children;
-    }
-
-    return <_CodeBlock.default {...(0, _react.isValidElement)(children) ? children === null || children === void 0 ? void 0 : children.props : { ...props
-    }} />;
-  },
-  details: props => {
-    const items = _react.default.Children.toArray(props.children); // Split summary item from the rest to pass it as a separate prop to the Detais theme component
-
-
-    const summary = items.find(item => {
-      var _item$props;
-
-      return (item === null || item === void 0 ? void 0 : (_item$props = item.props) === null || _item$props === void 0 ? void 0 : _item$props.mdxType) === 'summary';
-    });
-    const children = <>{items.filter(item => item !== summary)}</>;
-    return <_Details.default {...props} summary={summary}>
-        {children}
-      </_Details.default>;
-  },
-  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/MDXComponents/styles.css

@@ -1,11 +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.
- */
-
-ul.contains-task-list {
-  padding-left: 0;
-  list-style: none;
-}

package/lib/theme/MDXPage/index.js

@@ -1,67 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-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");
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-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 {
-    // TODO this frontmatter is not validated/normalized, it's the raw user-provided one. We should expose normalized one too!
-    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 className="container container--fluid margin-vert--lg">
-        <div className={(0, _clsx.default)('row', _stylesModule.default.mdxPageWrapper)}>
-          <div className={(0, _clsx.default)('col', !hideTableOfContents && 'col--8')}>
-            <_react2.MDXProvider components={_MDXComponents.default}>
-              <MDXPageContent />
-            </_react2.MDXProvider>
-          </div>
-          {!hideTableOfContents && MDXPageContent.toc && <div className="col col--2">
-              <_TOC.default toc={MDXPageContent.toc} minHeadingLevel={frontMatter.toc_min_heading_level} maxHeadingLevel={frontMatter.toc_max_heading_level} />
-            </div>}
-        </div>
-      </main>
-    </_Layout.default>;
-}
-
-var _default = MDXPage;
-exports.default = _default;

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

@@ -1,10 +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.
- */
-
-.mdxPageWrapper {
-  justify-content: center;
-}