@docusaurus/theme-classic 2.0.0-beta.12faed89d → 2.0.0-beta.14

package/lib/theme/CodeBlock/index.js

@@ -1,253 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = CodeBlock;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _prismReactRenderer = _interopRequireWildcard(require("prism-react-renderer"));
-
-var _copyTextToClipboard = _interopRequireDefault(require("copy-text-to-clipboard"));
-
-var _parseNumericRange = _interopRequireDefault(require("parse-numeric-range"));
-
-var _usePrismTheme = _interopRequireDefault(require("@theme/hooks/usePrismTheme"));
-
-var _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-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.
- */
-const highlightLinesRangeRegex = /{([\d,-]+)}/;
-
-const getHighlightDirectiveRegex = (languages = ['js', 'jsBlock', 'jsx', 'python', 'html']) => {
-  // supported types of comments
-  const comments = {
-    js: {
-      start: '\\/\\/',
-      end: ''
-    },
-    jsBlock: {
-      start: '\\/\\*',
-      end: '\\*\\/'
-    },
-    jsx: {
-      start: '\\{\\s*\\/\\*',
-      end: '\\*\\/\\s*\\}'
-    },
-    python: {
-      start: '#',
-      end: ''
-    },
-    html: {
-      start: '<!--',
-      end: '-->'
-    }
-  }; // supported directives
-
-  const directives = ['highlight-next-line', 'highlight-start', 'highlight-end'].join('|'); // to be more reliable, the opening and closing comment must match
-
-  const commentPattern = languages.map(lang => `(?:${comments[lang].start}\\s*(${directives})\\s*${comments[lang].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
-
-
-const highlightDirectiveRegex = lang => {
-  switch (lang) {
-    case 'js':
-    case 'javascript':
-    case 'ts':
-    case 'typescript':
-      return getHighlightDirectiveRegex(['js', 'jsBlock']);
-
-    case 'jsx':
-    case 'tsx':
-      return getHighlightDirectiveRegex(['js', 'jsBlock', 'jsx']);
-
-    case 'html':
-      return getHighlightDirectiveRegex(['js', 'jsBlock', 'html']);
-
-    case 'python':
-    case 'py':
-      return getHighlightDirectiveRegex(['python']);
-
-    default:
-      // all comment types
-      return getHighlightDirectiveRegex();
-  }
-};
-
-function CodeBlock({
-  children,
-  className: languageClassName,
-  metastring,
-  title
-}) {
-  const {
-    prism
-  } = (0, _themeCommon.useThemeConfig)();
-  const [showCopied, setShowCopied] = (0, _react.useState)(false);
-  const [mounted, setMounted] = (0, _react.useState)(false); // The Prism theme on SSR is always the default theme but the site theme
-  // can be in a different mode. React hydration doesn't update DOM styles
-  // that come from SSR. Hence force a re-render after mounting to apply the
-  // current relevant styles. There will be a flash seen of the original
-  // styles seen using this current approach but that's probably ok. Fixing
-  // the flash will require changing the theming approach and is not worth it
-  // at this point.
-
-  (0, _react.useEffect)(() => {
-    setMounted(true);
-  }, []); // TODO: the title is provided by MDX as props automatically
-  // so we probably don't need to parse the metastring
-  // (note: title="xyz" => title prop still has the quotes)
-
-  const codeBlockTitle = (0, _themeCommon.parseCodeBlockTitle)(metastring) || title;
-  const button = (0, _react.useRef)(null);
-  let highlightLines = [];
-  const prismTheme = (0, _usePrismTheme.default)(); // In case interleaved Markdown (e.g. when using CodeBlock as standalone component).
-
-  const content = Array.isArray(children) ? children.join('') : children;
-
-  if (metastring && highlightLinesRangeRegex.test(metastring)) {
-    // Tested above
-    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-    const highlightLinesRange = metastring.match(highlightLinesRangeRegex)[1];
-    highlightLines = (0, _parseNumericRange.default)(highlightLinesRange).filter(n => n > 0);
-  }
-
-  let language = languageClassName && // Force Prism's language union type to `any` because it does not contain all available languages
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  languageClassName.replace(/language-/, '');
-
-  if (!language && prism.defaultLanguage) {
-    language = prism.defaultLanguage;
-  } // only declaration OR directive highlight can be used for a block
-
-
-  let code = content.replace(/\n$/, '');
-
-  if (highlightLines.length === 0 && language !== undefined) {
-    let range = '';
-    const directiveRegex = highlightDirectiveRegex(language); // go through line by line
-
-    const lines = content.replace(/\n$/, '').split('\n');
-    let blockStart; // loop through lines
-
-    for (let index = 0; index < lines.length;) {
-      const line = lines[index]; // adjust for 0-index
-
-      const lineNumber = index + 1;
-      const match = line.match(directiveRegex);
-
-      if (match !== null) {
-        const directive = match.slice(1).reduce((final, item) => final || item, undefined);
-
-        switch (directive) {
-          case 'highlight-next-line':
-            range += `${lineNumber},`;
-            break;
-
-          case 'highlight-start':
-            blockStart = lineNumber;
-            break;
-
-          case 'highlight-end':
-            range += `${blockStart}-${lineNumber - 1},`;
-            break;
-
-          default:
-            break;
-        }
-
-        lines.splice(index, 1);
-      } else {
-        // lines without directives are unchanged
-        index += 1;
-      }
-    }
-
-    highlightLines = (0, _parseNumericRange.default)(range);
-    code = lines.join('\n');
-  }
-
-  const handleCopyCode = () => {
-    (0, _copyTextToClipboard.default)(code);
-    setShowCopied(true);
-    setTimeout(() => setShowCopied(false), 2000);
-  };
-
-  return <_prismReactRenderer.default {..._prismReactRenderer.defaultProps} key={String(mounted)} theme={prismTheme} code={code} language={language}>
-      {({
-      className,
-      style,
-      tokens,
-      getLineProps,
-      getTokenProps
-    }) => <div className={_stylesModule.default.codeBlockContainer}>
-          {codeBlockTitle && <div style={style} className={_stylesModule.default.codeBlockTitle}>
-              {codeBlockTitle}
-            </div>}
-          <div className={(0, _clsx.default)(_stylesModule.default.codeBlockContent, language)}>
-            <pre
-        /* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */
-        tabIndex={0} className={(0, _clsx.default)(className, _stylesModule.default.codeBlock, 'thin-scrollbar', {
-          [_stylesModule.default.codeBlockWithTitle]: codeBlockTitle
-        })} style={style}>
-              <code className={_stylesModule.default.codeBlockLines}>
-                {tokens.map((line, i) => {
-              if (line.length === 1 && line[0].content === '') {
-                line[0].content = '\n'; // eslint-disable-line no-param-reassign
-              }
-
-              const lineProps = getLineProps({
-                line,
-                key: i
-              });
-
-              if (highlightLines.includes(i + 1)) {
-                lineProps.className += ' docusaurus-highlight-code-line';
-              }
-
-              return <span key={i} {...lineProps}>
-                      {line.map((token, key) => <span key={key} {...getTokenProps({
-                  token,
-                  key
-                })} />)}
-                    </span>;
-            })}
-              </code>
-            </pre>
-
-            <button ref={button} type="button" aria-label={(0, _Translate.translate)({
-          id: 'theme.CodeBlock.copyButtonAriaLabel',
-          message: 'Copy code to clipboard',
-          description: 'The ARIA label for copy code blocks button'
-        })} className={(0, _clsx.default)(_stylesModule.default.copyButton, 'clean-btn')} onClick={handleCopyCode}>
-              {showCopied ? <_Translate.default id="theme.CodeBlock.copied" description="The copied button label on code blocks">
-                  Copied
-                </_Translate.default> : <_Translate.default id="theme.CodeBlock.copy" description="The copy button label on code blocks">
-                  Copy
-                </_Translate.default>}
-            </button>
-          </div>
-        </div>}
-    </_prismReactRenderer.default>;
-}

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

@@ -1,68 +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.
- */
-
-.codeBlockContainer {
-  margin-bottom: var(--ifm-leading);
-}
-
-.codeBlockContent {
-  position: relative;
-  /*rtl:ignore*/
-  direction: ltr;
-}
-
-.codeBlockTitle {
-  border-top-left-radius: var(--ifm-global-radius);
-  border-top-right-radius: var(--ifm-global-radius);
-  border-bottom: 1px solid var(--ifm-color-emphasis-300);
-  font-size: var(--ifm-code-font-size);
-  font-weight: 500;
-  padding: 0.75rem var(--ifm-pre-padding);
-}
-
-.codeBlock {
-  padding: 0;
-}
-
-.codeBlockWithTitle {
-  border-top-left-radius: 0;
-  border-top-right-radius: 0;
-}
-
-.copyButton {
-  background: rgba(0, 0, 0, 0.3);
-  border-radius: var(--ifm-global-radius);
-  color: var(--ifm-color-white);
-  opacity: 0;
-  user-select: none;
-  padding: 0.4rem 0.5rem;
-  position: absolute;
-  right: calc(var(--ifm-pre-padding) / 2);
-  top: calc(var(--ifm-pre-padding) / 2);
-  transition: opacity 200ms ease-in-out;
-}
-
-.codeBlockTitle:hover + .codeBlockContent .copyButton,
-.codeBlockContent:hover > .copyButton,
-.copyButton:focus {
-  opacity: 1;
-}
-
-.codeBlockLines {
-  font: inherit;
-  float: left;
-  min-width: 100%;
-  padding: var(--ifm-pre-padding);
-  display: flex;
-  flex-direction: column;
-}
-
-@media print {
-  .codeBlockLines {
-    white-space: pre-wrap;
-  }
-}

package/lib/theme/DocItem/index.js

@@ -1,138 +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 _useDocs = require("@theme/hooks/useDocs");
-
-var _useWindowSize = _interopRequireDefault(require("@theme/hooks/useWindowSize"));
-
-var _DocPaginator = _interopRequireDefault(require("@theme/DocPaginator"));
-
-var _DocVersionBanner = _interopRequireDefault(require("@theme/DocVersionBanner"));
-
-var _Seo = _interopRequireDefault(require("@theme/Seo"));
-
-var _LastUpdated = _interopRequireDefault(require("@theme/LastUpdated"));
-
-var _TOC = _interopRequireDefault(require("@theme/TOC"));
-
-var _TOCCollapsible = _interopRequireDefault(require("@theme/TOCCollapsible"));
-
-var _EditThisPage = _interopRequireDefault(require("@theme/EditThisPage"));
-
-var _Heading = require("@theme/Heading");
-
-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 DocItem(props) {
-  const {
-    content: DocContent,
-    versionMetadata
-  } = props;
-  const {
-    metadata,
-    frontMatter
-  } = DocContent;
-  const {
-    image,
-    keywords,
-    hide_title: hideTitle,
-    hide_table_of_contents: hideTableOfContents
-  } = frontMatter;
-  const {
-    description,
-    title,
-    editUrl,
-    lastUpdatedAt,
-    formattedLastUpdatedAt,
-    lastUpdatedBy
-  } = metadata;
-  const {
-    pluginId
-  } = (0, _useDocs.useActivePlugin)({
-    failfast: true
-  });
-  const versions = (0, _useDocs.useVersions)(pluginId); // If site is not versioned or only one version is included
-  // we don't show the version badge
-  // See https://github.com/facebook/docusaurus/issues/3362
-
-  const showVersionBadge = versions.length > 1; // We only add a title if:
-  // - user asks to hide it with frontmatter
-  // - the markdown content does not already contain a top-level h1 heading
-
-  const shouldAddTitle = !hideTitle && typeof DocContent.contentTitle === 'undefined';
-  const windowSize = (0, _useWindowSize.default)();
-  const renderTocMobile = !hideTableOfContents && DocContent.toc && (windowSize === 'mobile' || windowSize === 'ssr');
-  const renderTocDesktop = !hideTableOfContents && DocContent.toc && (windowSize === 'desktop' || windowSize === 'ssr');
-  return <>
-      <_Seo.default {...{
-      title,
-      description,
-      keywords,
-      image
-    }} />
-
-      <div className="row">
-        <div className={(0, _clsx.default)('col', {
-        [_stylesModule.default.docItemCol]: !hideTableOfContents
-      })}>
-          <_DocVersionBanner.default versionMetadata={versionMetadata} />
-          <div className={_stylesModule.default.docItemContainer}>
-            <article>
-              {showVersionBadge && <span className="badge badge--secondary">
-                  Version: {versionMetadata.label}
-                </span>}
-
-              {renderTocMobile && <_TOCCollapsible.default toc={DocContent.toc} className={_stylesModule.default.tocMobile} />}
-
-              <div className="markdown">
-                {
-                /*
-                Title can be declared inside md content or declared through frontmatter and added manually
-                To make both cases consistent, the added title is added under the same div.markdown block
-                See https://github.com/facebook/docusaurus/pull/4882#issuecomment-853021120
-                */
-              }
-                {shouldAddTitle && <_Heading.MainHeading>{title}</_Heading.MainHeading>}
-
-                <DocContent />
-              </div>
-
-              {(editUrl || lastUpdatedAt || lastUpdatedBy) && <footer className="row docusaurus-mt-lg">
-                  <div className="col">
-                    {editUrl && <_EditThisPage.default editUrl={editUrl} />}
-                  </div>
-
-                  <div className={(0, _clsx.default)('col', _stylesModule.default.lastUpdated)}>
-                    {(lastUpdatedAt || lastUpdatedBy) && <_LastUpdated.default lastUpdatedAt={lastUpdatedAt} formattedLastUpdatedAt={formattedLastUpdatedAt} lastUpdatedBy={lastUpdatedBy} />}
-                  </div>
-                </footer>}
-            </article>
-
-            <_DocPaginator.default metadata={metadata} />
-          </div>
-        </div>
-        {renderTocDesktop && <div className="col col--3">
-            <_TOC.default toc={DocContent.toc} />
-          </div>}
-      </div>
-    </>;
-}
-
-var _default = DocItem;
-exports.default = _default;

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

@@ -1,31 +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.
- */
-
-.docItemContainer header + * {
-  margin-top: 0;
-}
-
-.lastUpdated {
-  margin-top: 0.2rem;
-  font-style: italic;
-  font-size: smaller;
-}
-
-@media only screen and (min-width: 997px) {
-  .docItemCol {
-    max-width: 75% !important;
-  }
-
-  .lastUpdated {
-    text-align: right;
-  }
-
-  /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
-  .tocMobile {
-    display: none;
-  }
-}

package/lib/theme/DocPage/index.js

@@ -1,139 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = void 0;
-
-var _react = _interopRequireWildcard(require("react"));
-
-var _react2 = require("@mdx-js/react");
-
-var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
-
-var _renderRoutes = _interopRequireDefault(require("@docusaurus/renderRoutes"));
-
-var _Layout = _interopRequireDefault(require("@theme/Layout"));
-
-var _DocSidebar = _interopRequireDefault(require("@theme/DocSidebar"));
-
-var _MDXComponents = _interopRequireDefault(require("@theme/MDXComponents"));
-
-var _NotFound = _interopRequireDefault(require("@theme/NotFound"));
-
-var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
-
-var _router = require("@docusaurus/router");
-
-var _Translate = require("@docusaurus/Translate");
-
-var _clsx = _interopRequireDefault(require("clsx"));
-
-var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
-
-var _themeCommon = require("@docusaurus/theme-common");
-
-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.
- */
-function DocPageContent({
-  currentDocRoute,
-  versionMetadata,
-  children
-}) {
-  const {
-    siteConfig,
-    isClient
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    pluginId,
-    version
-  } = versionMetadata;
-  const sidebarName = currentDocRoute.sidebar;
-  const sidebar = sidebarName ? versionMetadata.docsSidebars[sidebarName] : undefined;
-  const [hiddenSidebarContainer, setHiddenSidebarContainer] = (0, _react.useState)(false);
-  const [hiddenSidebar, setHiddenSidebar] = (0, _react.useState)(false);
-  const toggleSidebar = (0, _react.useCallback)(() => {
-    if (hiddenSidebar) {
-      setHiddenSidebar(false);
-    }
-
-    setHiddenSidebarContainer(!hiddenSidebarContainer);
-  }, [hiddenSidebar]);
-  return <_Layout.default key={isClient} wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docPages} pageClassName={_themeCommon.ThemeClassNames.page.docPage} searchMetadatas={{
-    version,
-    tag: (0, _themeCommon.docVersionSearchTag)(pluginId, version)
-  }}>
-      <div className={_stylesModule.default.docPage}>
-        {sidebar && <aside className={(0, _clsx.default)(_stylesModule.default.docSidebarContainer, {
-        [_stylesModule.default.docSidebarContainerHidden]: hiddenSidebarContainer
-      })} onTransitionEnd={e => {
-        if (!e.currentTarget.classList.contains(_stylesModule.default.docSidebarContainer)) {
-          return;
-        }
-
-        if (hiddenSidebarContainer) {
-          setHiddenSidebar(true);
-        }
-      }}>
-            <_DocSidebar.default key={// Reset sidebar state on sidebar changes
-        // See https://github.com/facebook/docusaurus/issues/3414
-        sidebarName} sidebar={sidebar} path={currentDocRoute.path} sidebarCollapsible={siteConfig.themeConfig.sidebarCollapsible} onCollapse={toggleSidebar} isHidden={hiddenSidebar} />
-
-            {hiddenSidebar && <div className={_stylesModule.default.collapsedDocSidebar} title={(0, _Translate.translate)({
-          id: 'theme.docs.sidebar.expandButtonTitle',
-          message: 'Expand sidebar',
-          description: 'The ARIA label and title attribute for expand button of doc sidebar'
-        })} aria-label={(0, _Translate.translate)({
-          id: 'theme.docs.sidebar.expandButtonAriaLabel',
-          message: 'Expand sidebar',
-          description: 'The ARIA label and title attribute for expand button of doc sidebar'
-        })} tabIndex={0} role="button" onKeyDown={toggleSidebar} onClick={toggleSidebar}>
-                <_IconArrow.default className={_stylesModule.default.expandSidebarButtonIcon} />
-              </div>}
-          </aside>}
-        <main className={(0, _clsx.default)(_stylesModule.default.docMainContainer, {
-        [_stylesModule.default.docMainContainerEnhanced]: hiddenSidebarContainer || !sidebar
-      })}>
-          <div className={(0, _clsx.default)('container padding-top--md padding-bottom--lg', _stylesModule.default.docItemWrapper, {
-          [_stylesModule.default.docItemWrapperEnhanced]: hiddenSidebarContainer
-        })}>
-            <_react2.MDXProvider components={_MDXComponents.default}>{children}</_react2.MDXProvider>
-          </div>
-        </main>
-      </div>
-    </_Layout.default>;
-}
-
-function DocPage(props) {
-  const {
-    route: {
-      routes: docRoutes
-    },
-    versionMetadata,
-    location
-  } = props;
-  const currentDocRoute = docRoutes.find(docRoute => (0, _router.matchPath)(location.pathname, docRoute));
-
-  if (!currentDocRoute) {
-    return <_NotFound.default {...props} />;
-  }
-
-  return <DocPageContent currentDocRoute={currentDocRoute} versionMetadata={versionMetadata}>
-      {(0, _renderRoutes.default)(docRoutes, {
-      versionMetadata
-    })}
-    </DocPageContent>;
-}
-
-var _default = DocPage;
-exports.default = _default;