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

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

@@ -1,124 +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.
- */
-
-:root {
-  --collapse-button-bg-color-dark: #2e333a;
-}
-
-@media (min-width: 997px) {
-  .sidebar {
-    display: flex;
-    flex-direction: column;
-    max-height: 100vh;
-    height: 100%;
-    position: sticky;
-    top: 0;
-    padding-top: var(--ifm-navbar-height);
-    width: var(--doc-sidebar-width);
-    transition: opacity 50ms ease;
-  }
-
-  .sidebarWithHideableNavbar {
-    padding-top: 0;
-  }
-
-  .sidebarHidden {
-    opacity: 0;
-    height: 0;
-    overflow: hidden;
-    visibility: hidden;
-  }
-
-  .sidebarLogo {
-    display: flex !important;
-    align-items: center;
-    margin: 0 var(--ifm-navbar-padding-horizontal);
-    min-height: var(--ifm-navbar-height);
-    max-height: var(--ifm-navbar-height);
-    color: inherit !important;
-    text-decoration: none !important;
-  }
-
-  .sidebarLogo img {
-    margin-right: 0.5rem;
-    height: 2rem;
-  }
-
-  .menu {
-    flex-grow: 1;
-    padding: 0.5rem;
-  }
-
-  .menuLinkText {
-    cursor: initial;
-  }
-
-  .menuLinkText:hover {
-    background: none;
-  }
-
-  .menuWithAnnouncementBar {
-    margin-bottom: var(--docusaurus-announcement-bar-height);
-  }
-
-  .collapseSidebarButton {
-    display: block !important;
-    background-color: var(--ifm-button-background-color);
-    height: 40px;
-    position: sticky;
-    bottom: 0;
-    border-radius: 0;
-    border: 1px solid var(--ifm-toc-border-color);
-  }
-
-  .collapseSidebarButtonIcon {
-    transform: rotate(180deg);
-    margin-top: 4px;
-  }
-  html[dir='rtl'] .collapseSidebarButtonIcon {
-    transform: rotate(0);
-  }
-
-  html[data-theme='dark'] .collapseSidebarButton {
-    background-color: var(--collapse-button-bg-color-dark);
-  }
-
-  html[data-theme='dark'] .collapseSidebarButton:hover,
-  html[data-theme='dark'] .collapseSidebarButton:focus {
-    background-color: var(--ifm-color-emphasis-200);
-  }
-}
-
-.sidebarLogo,
-.collapseSidebarButton {
-  display: none;
-}
-
-.sidebarMenuIcon {
-  vertical-align: middle;
-}
-
-.sidebarMenuCloseIcon {
-  display: inline-flex;
-  justify-content: center;
-  align-items: center;
-  height: 24px;
-  font-size: 1.5rem;
-  font-weight: var(--ifm-font-weight-bold);
-  line-height: 0.9;
-  width: 24px;
-}
-
-:global(.menu__list) :global(.menu__list) {
-  overflow-y: hidden;
-  will-change: height;
-  transition: height var(--ifm-transition-fast) linear;
-}
-
-:global(.menu__list-item--collapsed) :global(.menu__list) {
-  height: 0 !important;
-}

package/lib/theme/DocVersionBanner/index.js

@@ -1,128 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-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 UnreleasedVersionLabel({
-  siteTitle,
-  versionMetadata
-}) {
-  return <_Translate.default id="theme.docs.versions.unreleasedVersionLabel" description="The label used to tell the user that he's browsing an unreleased doc version" values={{
-    siteTitle,
-    versionLabel: <b>{versionMetadata.label}</b>
-  }}>
-      {'This is unreleased documentation for {siteTitle} {versionLabel} version.'}
-    </_Translate.default>;
-}
-
-function UnmaintainedVersionLabel({
-  siteTitle,
-  versionMetadata
-}) {
-  return <_Translate.default id="theme.docs.versions.unmaintainedVersionLabel" description="The label used to tell the user that he's browsing an unmaintained doc version" values={{
-    siteTitle,
-    versionLabel: <b>{versionMetadata.label}</b>
-  }}>
-      {'This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.'}
-    </_Translate.default>;
-}
-
-const BannerLabelComponents = {
-  unreleased: UnreleasedVersionLabel,
-  unmaintained: UnmaintainedVersionLabel
-};
-
-function BannerLabel(props) {
-  const BannerLabelComponent = BannerLabelComponents[props.versionMetadata.banner];
-  return <BannerLabelComponent {...props} />;
-}
-
-function LatestVersionSuggestionLabel({
-  versionLabel,
-  to,
-  onClick
-}) {
-  return <_Translate.default id="theme.docs.versions.latestVersionSuggestionLabel" description="The label used to tell the user to check the latest version" values={{
-    versionLabel,
-    latestVersionLink: <b>
-            <_Link.default to={to} onClick={onClick}>
-              <_Translate.default id="theme.docs.versions.latestVersionLinkLabel" description="The label used for the latest version suggestion link label">
-                latest version
-              </_Translate.default>
-            </_Link.default>
-          </b>
-  }}>
-      {'For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).'}
-    </_Translate.default>;
-}
-
-function DocVersionBannerEnabled({
-  versionMetadata
-}) {
-  const {
-    siteConfig: {
-      title: siteTitle
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    pluginId
-  } = (0, _useDocs.useActivePlugin)({
-    failfast: true
-  });
-
-  const getVersionMainDoc = version => version.docs.find(doc => doc.id === version.mainDocId);
-
-  const {
-    savePreferredVersionName
-  } = (0, _themeCommon.useDocsPreferredVersion)(pluginId);
-  const {
-    latestDocSuggestion,
-    latestVersionSuggestion
-  } = (0, _useDocs.useDocVersionSuggestions)(pluginId); // try to link to same doc in latest version (not always possible)
-  // fallback to main doc of latest version
-
-  const latestVersionSuggestedDoc = latestDocSuggestion !== null && latestDocSuggestion !== void 0 ? latestDocSuggestion : getVersionMainDoc(latestVersionSuggestion);
-  return <div className="alert alert--warning margin-bottom--md" role="alert">
-      <div>
-        <BannerLabel siteTitle={siteTitle} versionMetadata={versionMetadata} />
-      </div>
-      <div className="margin-top--md">
-        <LatestVersionSuggestionLabel versionLabel={latestVersionSuggestion.label} to={latestVersionSuggestedDoc.path} onClick={() => savePreferredVersionName(latestVersionSuggestion.name)} />
-      </div>
-    </div>;
-}
-
-function DocVersionBanner({
-  versionMetadata
-}) {
-  if (versionMetadata.banner === 'none') {
-    return <></>;
-  } else {
-    return <DocVersionBannerEnabled versionMetadata={versionMetadata} />;
-  }
-}
-
-var _default = DocVersionBanner;
-exports.default = _default;

package/lib/theme/DocVersionSuggestions/index.js

@@ -1,111 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-var _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
-
-var _useDocs = require("@theme/hooks/useDocs");
-
-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 UnreleasedVersionLabel({
-  siteTitle,
-  versionLabel
-}) {
-  return <_Translate.default id="theme.docs.versions.unreleasedVersionLabel" description="The label used to tell the user that he's browsing an unreleased doc version" values={{
-    siteTitle,
-    versionLabel: <b>{versionLabel}</b>
-  }}>
-      {'This is unreleased documentation for {siteTitle} {versionLabel} version.'}
-    </_Translate.default>;
-}
-
-function UnmaintainedVersionLabel({
-  siteTitle,
-  versionLabel
-}) {
-  return <_Translate.default id="theme.docs.versions.unmaintainedVersionLabel" description="The label used to tell the user that he's browsing an unmaintained doc version" values={{
-    siteTitle,
-    versionLabel: <b>{versionLabel}</b>
-  }}>
-      {'This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.'}
-    </_Translate.default>;
-}
-
-function LatestVersionSuggestionLabel({
-  versionLabel,
-  to,
-  onClick
-}) {
-  return <_Translate.default id="theme.docs.versions.latestVersionSuggestionLabel" description="The label userd to tell the user that he's browsing an unmaintained doc version" values={{
-    versionLabel,
-    latestVersionLink: <b>
-            <_Link.default to={to} onClick={onClick}>
-              <_Translate.default id="theme.docs.versions.latestVersionLinkLabel" description="The label used for the latest version suggestion link label">
-                latest version
-              </_Translate.default>
-            </_Link.default>
-          </b>
-  }}>
-      {'For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).'}
-    </_Translate.default>;
-}
-
-const getVersionMainDoc = version => version.docs.find(doc => doc.id === version.mainDocId);
-
-function DocVersionSuggestions() {
-  const {
-    siteConfig: {
-      title: siteTitle
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    pluginId
-  } = (0, _useDocs.useActivePlugin)({
-    failfast: true
-  });
-  const {
-    savePreferredVersionName
-  } = (0, _themeCommon.useDocsPreferredVersion)(pluginId);
-  const activeVersion = (0, _useDocs.useActiveVersion)(pluginId);
-  const {
-    latestDocSuggestion,
-    latestVersionSuggestion
-  } = (0, _useDocs.useDocVersionSuggestions)(pluginId); // No suggestion to be made
-
-  if (!latestVersionSuggestion) {
-    return <></>;
-  } // try to link to same doc in latest version (not always possible)
-  // fallback to main doc of latest version
-
-
-  const latestVersionSuggestedDoc = latestDocSuggestion !== null && latestDocSuggestion !== void 0 ? latestDocSuggestion : getVersionMainDoc(latestVersionSuggestion);
-  return <div className="alert alert--warning margin-bottom--md" role="alert">
-      <div>
-        {activeVersion.name === 'current' ? <UnreleasedVersionLabel siteTitle={siteTitle} versionLabel={activeVersion.label} /> : <UnmaintainedVersionLabel siteTitle={siteTitle} versionLabel={activeVersion.label} />}
-      </div>
-      <div className="margin-top--md">
-        <LatestVersionSuggestionLabel versionLabel={latestVersionSuggestion.label} to={latestVersionSuggestedDoc.path} onClick={() => savePreferredVersionName(latestVersionSuggestion.name)} />
-      </div>
-    </div>;
-}
-
-var _default = DocVersionSuggestions;
-exports.default = _default;

package/lib/theme/EditThisPage/index.js

@@ -1,31 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = EditThisPage;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
-
-var _IconEdit = _interopRequireDefault(require("@theme/IconEdit"));
-
-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 EditThisPage({
-  editUrl
-}) {
-  return <a href={editUrl} target="_blank" rel="noreferrer noopener">
-      <_IconEdit.default />
-      <_Translate.default id="theme.common.editThisPage" description="The link label to edit the current page">
-        Edit this page
-      </_Translate.default>
-    </a>;
-}

package/lib/theme/Footer/index.js

@@ -1,108 +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 _Link = _interopRequireDefault(require("@docusaurus/Link"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-var _useBaseUrl = _interopRequireDefault(require("@docusaurus/useBaseUrl"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-var _ThemedImage = _interopRequireDefault(require("@theme/ThemedImage"));
-
-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 FooterLink({
-  to,
-  href,
-  label,
-  prependBaseUrlToHref,
-  ...props
-}) {
-  const toUrl = (0, _useBaseUrl.default)(to);
-  const normalizedHref = (0, _useBaseUrl.default)(href, {
-    forcePrependBaseUrl: true
-  });
-  return <_Link.default className="footer__link-item" {...href ? {
-    href: prependBaseUrlToHref ? normalizedHref : href
-  } : {
-    to: toUrl
-  }} {...props}>
-      {label}
-    </_Link.default>;
-}
-
-const FooterLogo = ({
-  sources,
-  alt
-}) => <_ThemedImage.default className="footer__logo" alt={alt} sources={sources} />;
-
-function Footer() {
-  const {
-    footer
-  } = (0, _themeCommon.useThemeConfig)();
-  const {
-    copyright,
-    links = [],
-    logo = {}
-  } = footer || {};
-  const sources = {
-    light: (0, _useBaseUrl.default)(logo.src),
-    dark: (0, _useBaseUrl.default)(logo.srcDark || logo.src)
-  };
-
-  if (!footer) {
-    return null;
-  }
-
-  return <footer className={(0, _clsx.default)('footer', {
-    'footer--dark': footer.style === 'dark'
-  })}>
-      <div className="container">
-        {links && links.length > 0 && <div className="row footer__links">
-            {links.map((linkItem, i) => <div key={i} className="col footer__col">
-                {linkItem.title != null ? <div className="footer__title">{linkItem.title}</div> : null}
-                {linkItem.items != null && Array.isArray(linkItem.items) && linkItem.items.length > 0 ? <ul className="footer__items">
-                    {linkItem.items.map((item, key) => item.html ? <li key={key} className="footer__item" // Developer provided the HTML, so assume it's safe.
-            // eslint-disable-next-line react/no-danger
-            dangerouslySetInnerHTML={{
-              __html: item.html
-            }} /> : <li key={item.href || item.to} className="footer__item">
-                          <FooterLink {...item} />
-                        </li>)}
-                  </ul> : null}
-              </div>)}
-          </div>}
-        {(logo || copyright) && <div className="footer__bottom text--center">
-            {logo && (logo.src || logo.srcDark) && <div className="margin-bottom--sm">
-                {logo.href ? <_Link.default href={logo.href} className={_stylesModule.default.footerLogoLink}>
-                    <FooterLogo alt={logo.alt} sources={sources} />
-                  </_Link.default> : <FooterLogo alt={logo.alt} sources={sources} />}
-              </div>}
-            {copyright ? <div className="footer__copyright" // Developer provided the HTML, so assume it's safe.
-        // eslint-disable-next-line react/no-danger
-        dangerouslySetInnerHTML={{
-          __html: copyright
-        }} /> : null}
-          </div>}
-      </div>
-    </footer>;
-}
-
-var _default = Footer;
-exports.default = _default;

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

@@ -1,15 +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.
- */
-
-.footerLogoLink {
-  opacity: 0.5;
-  transition: opacity var(--ifm-transition-fast) var(--ifm-transition-timing-default);
-}
-
-.footerLogoLink:hover {
-  opacity: 1;
-}

package/lib/theme/Heading/index.js

@@ -1,76 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.MainHeading = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _Translate = require("@docusaurus/Translate");
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-require("./styles.css");
-
-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.
- */
-
-/* eslint-disable jsx-a11y/anchor-has-content, jsx-a11y/anchor-is-valid */
-const MainHeading = function MainHeading({ ...props
-}) {
-  return <header>
-      <h1 {...props} id={undefined} // h1 headings do not need an id because they don't appear in the TOC
-    className={_stylesModule.default.h1Heading}>
-        {props.children}
-      </h1>
-    </header>;
-};
-
-exports.MainHeading = MainHeading;
-
-const createAnchorHeading = Tag => function TargetComponent({
-  id,
-  ...props
-}) {
-  const {
-    navbar: {
-      hideOnScroll
-    }
-  } = (0, _themeCommon.useThemeConfig)();
-
-  if (!id) {
-    return <Tag {...props} />;
-  }
-
-  return <Tag {...props}>
-        <a aria-hidden="true" tabIndex={-1} className={(0, _clsx.default)('anchor', {
-      [_stylesModule.default.enhancedAnchor]: !hideOnScroll
-    })} id={id} />
-        {props.children}
-        <a className="hash-link" href={`#${id}`} title={(0, _Translate.translate)({
-      id: 'theme.common.headingLinkTitle',
-      message: 'Direct link to heading',
-      description: 'Title for link to heading'
-    })}>
-          #
-        </a>
-      </Tag>;
-};
-
-const Heading = headingType => {
-  return headingType === 'h1' ? MainHeading : createAnchorHeading(headingType);
-};
-
-var _default = Heading;
-exports.default = _default;

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

@@ -1,15 +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.
- */
-
-.enhancedAnchor {
-  top: calc(var(--ifm-navbar-height) * -1 - 0.5rem);
-}
-
-.h1Heading {
-  font-size: 3rem;
-  margin-bottom: calc(var(--ifm-leading-desktop) * var(--ifm-leading));
-}

package/lib/theme/IconArrow/index.js

@@ -1,28 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireDefault(require("react"));
-
-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 IconArrow = props => {
-  return <svg width="20" height="20" aria-hidden="true" {...props}>
-      <g fill="#7a7a7a">
-        <path d="M9.992 10.023c0 .2-.062.399-.172.547l-4.996 7.492a.982.982 0 01-.828.454H1c-.55 0-1-.453-1-1 0-.2.059-.403.168-.551l4.629-6.942L.168 3.078A.939.939 0 010 2.528c0-.548.45-.997 1-.997h2.996c.352 0 .649.18.828.45L9.82 9.472c.11.148.172.347.172.55zm0 0" />
-        <path d="M19.98 10.023c0 .2-.058.399-.168.547l-4.996 7.492a.987.987 0 01-.828.454h-3c-.547 0-.996-.453-.996-1 0-.2.059-.403.168-.551l4.625-6.942-4.625-6.945a.939.939 0 01-.168-.55 1 1 0 01.996-.997h3c.348 0 .649.18.828.45l4.996 7.492c.11.148.168.347.168.55zm0 0" />
-      </g>
-    </svg>;
-};
-
-var _default = IconArrow;
-exports.default = _default;

package/lib/theme/IconEdit/index.js

@@ -1,34 +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 _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.
- */
-const IconEdit = ({
-  className,
-  ...restProps
-}) => {
-  return <svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" className={(0, _clsx.default)(_stylesModule.default.iconEdit, className)} aria-hidden="true" {...restProps}>
-      <g>
-        <path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z" />
-      </g>
-    </svg>;
-};
-
-var _default = IconEdit;
-exports.default = _default;