@docusaurus/theme-classic 2.0.0-beta.ff31de0ff → 2.0.0-rc.1

package/lib/__tests__/validateThemeConfig.test.js

@@ -1,333 +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.
- */
-
-import {merge} from 'lodash';
-
-const {ThemeConfigSchema, DEFAULT_CONFIG} = require('../validateThemeConfig');
-
-const {normalizeThemeConfig} = require('@docusaurus/utils-validation');
-const theme = require('prism-react-renderer/themes/github');
-const darkTheme = require('prism-react-renderer/themes/dracula');
-
-function testValidateThemeConfig(partialThemeConfig) {
-  return normalizeThemeConfig(ThemeConfigSchema, {
-    ...DEFAULT_CONFIG,
-    ...partialThemeConfig,
-  });
-}
-
-function testOk(partialThemeConfig) {
-  expect(
-    testValidateThemeConfig({...DEFAULT_CONFIG, ...partialThemeConfig}),
-  ).toEqual({
-    ...DEFAULT_CONFIG,
-    ...partialThemeConfig,
-  });
-}
-
-describe('themeConfig', () => {
-  test('should accept valid theme config', () => {
-    const userConfig = {
-      prism: {
-        theme,
-        darkTheme,
-        defaultLanguage: 'javascript',
-        additionalLanguages: ['kotlin', 'java'],
-      },
-      announcementBar: {
-        id: 'supportus',
-        content: 'pls support',
-        backgroundColor: '#fff',
-        textColor: '#000',
-        isCloseable: true,
-      },
-      image: 'img/docusaurus-soc.png',
-      navbar: {
-        style: 'primary',
-        hideOnScroll: true,
-        title: 'Docusaurus',
-        logo: {
-          alt: 'Docusaurus Logo',
-          src: 'img/docusaurus.svg',
-          srcDark: 'img/docusaurus_keytar.svg',
-        },
-        items: [
-          {
-            type: 'docsVersionDropdown',
-            position: 'left',
-            dropdownItemsBefore: [],
-            dropdownItemsAfter: [],
-          },
-          {
-            to: 'docs/next/support',
-            label: 'Community',
-            position: 'left',
-            activeBaseRegex: `docs/next/(support|team|resources)`,
-            'aria-label': 'Community',
-          },
-        ],
-      },
-      footer: {
-        style: 'dark',
-        links: [
-          {
-            title: 'Learn',
-            items: [
-              {
-                label: 'Introduction',
-                to: 'docs',
-              },
-            ],
-          },
-        ],
-        logo: {
-          alt: 'Facebook Open Source Logo',
-          src: 'img/oss_logo.png',
-          href: 'https://opensource.facebook.com',
-        },
-        copyright: `Copyright © ${new Date().getFullYear()} Facebook, Inc. Built with Docusaurus.`,
-      },
-    };
-    expect(testValidateThemeConfig(userConfig)).toEqual({
-      ...DEFAULT_CONFIG,
-      ...userConfig,
-    });
-  });
-
-  test('should allow possible types of navbar items', () => {
-    const config = {
-      navbar: {
-        items: [
-          // Doc link
-          {
-            type: 'doc',
-            position: 'left',
-            docId: 'intro',
-            label: 'Introduction',
-            activeSidebarClassName: 'custom-class',
-          },
-          // Regular link
-          {
-            to: '/guide/',
-            label: 'Guide',
-            position: 'left',
-            activeBaseRegex: '/guide/',
-          },
-          // Regular dropdown
-          {
-            label: 'Community',
-            position: 'right',
-            items: [
-              {
-                label: 'Facebook',
-                href: 'https://.facebook.com/',
-                target: '_self',
-              },
-              {
-                label: 'GitHub',
-                href: 'https://github.com/facebook/docusaurus',
-                className: 'github-link',
-              },
-            ],
-          },
-          // Doc version dropdown
-          {
-            type: 'docsVersionDropdown',
-            position: 'right',
-            dropdownActiveClassDisabled: true,
-            dropdownItemsBefore: [
-              {
-                href:
-                  'https://www.npmjs.com/package/docusaurus?activeTab=versions',
-                label: 'Versions on npm',
-                className: 'npm-styled',
-                target: '_self',
-              },
-            ],
-            dropdownItemsAfter: [
-              {
-                to: '/versions',
-                label: 'All versions',
-                className: 'all_vers',
-              },
-            ],
-          },
-          // External link with custom data attribute
-          {
-            href: 'https://github.com/facebook/docusaurus',
-            position: 'right',
-            className: 'header-github-link',
-            'aria-label': 'GitHub repository',
-          },
-          // Docs version
-          {
-            type: 'docsVersion',
-            position: 'left',
-            label: 'Current version',
-          },
-        ],
-      },
-    };
-    expect(testValidateThemeConfig(config)).toEqual({
-      ...DEFAULT_CONFIG,
-      navbar: {
-        ...DEFAULT_CONFIG.navbar,
-        ...config.navbar,
-      },
-    });
-  });
-
-  test('should allow empty alt tags for the logo image in the header', () => {
-    const altTagConfig = {
-      navbar: {
-        logo: {
-          alt: '',
-          src: '/arbitrary-logo.png',
-        },
-        hideOnScroll: false,
-      },
-    };
-    expect(testValidateThemeConfig(altTagConfig)).toEqual({
-      ...DEFAULT_CONFIG,
-      navbar: {
-        ...DEFAULT_CONFIG.navbar,
-        ...altTagConfig.navbar,
-      },
-    });
-  });
-
-  test('should allow empty alt tags for the logo image in the footer', () => {
-    const partialConfig = {
-      footer: {
-        logo: {
-          alt: '',
-          src: '/arbitrary-logo.png',
-        },
-      },
-    };
-    const normalizedConfig = testValidateThemeConfig(partialConfig);
-
-    expect(normalizedConfig).toEqual({
-      ...normalizedConfig,
-      footer: {
-        ...normalizedConfig.footer,
-        ...partialConfig.footer,
-      },
-    });
-  });
-
-  test('should accept valid prism config', () => {
-    const prismConfig = {
-      prism: {
-        additionalLanguages: ['kotlin', 'java'],
-      },
-    };
-    expect(testValidateThemeConfig(prismConfig)).toEqual({
-      ...DEFAULT_CONFIG,
-      ...prismConfig,
-    });
-  });
-
-  describe('customCss config', () => {
-    test('should accept customCss undefined', () => {
-      testOk({
-        customCss: undefined,
-      });
-    });
-
-    test('should accept customCss string', () => {
-      testOk({
-        customCss: './path/to/cssFile.css',
-      });
-    });
-
-    test('should accept customCss string array', () => {
-      testOk({
-        customCss: ['./path/to/cssFile.css', './path/to/cssFile2.css'],
-      });
-    });
-
-    test('should reject customCss number', () => {
-      expect(() =>
-        testValidateThemeConfig({
-          customCss: 42,
-        }),
-      ).toThrowErrorMatchingInlineSnapshot(
-        `"\\"customCss\\" must be one of [array, string]"`,
-      );
-    });
-  });
-
-  describe('color mode config', () => {
-    const withDefaultValues = (colorMode) =>
-      merge({}, DEFAULT_CONFIG.colorMode, colorMode);
-
-    test('minimal config', () => {
-      const colorMode = {
-        switchConfig: {
-          darkIcon: '🌙',
-        },
-      };
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-
-    test('max config', () => {
-      const colorMode = {
-        defaultMode: 'dark',
-        disableSwitch: false,
-        respectPrefersColorScheme: true,
-        switchConfig: {
-          darkIcon: '🌙',
-          darkIconStyle: {
-            marginTop: '1px',
-            marginLeft: '2px',
-          },
-          lightIcon: '☀️',
-          lightIconStyle: {
-            marginLeft: '1px',
-          },
-        },
-      };
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-
-    test('undefined config', () => {
-      const colorMode = undefined;
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-
-    test('empty config', () => {
-      const colorMode = {};
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: {
-          ...DEFAULT_CONFIG.colorMode,
-          ...colorMode,
-        },
-      });
-    });
-
-    test('empty switch config', () => {
-      const colorMode = {
-        switchConfig: {},
-      };
-      expect(testValidateThemeConfig({colorMode})).toEqual({
-        ...DEFAULT_CONFIG,
-        colorMode: withDefaultValues(colorMode),
-      });
-    });
-  });
-});

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

@@ -1,28 +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.
- */
-
-.docTitle {
-  font-size: 3rem;
-  margin-bottom: calc(var(--ifm-leading-desktop) * var(--ifm-leading));
-}
-
-.docItemContainer {
-  margin: 0 auto;
-  padding: 0 0.5rem;
-}
-
-@media only screen and (min-width: 997px) {
-  .docItemCol {
-    max-width: 75% !important;
-  }
-}
-
-@media only screen and (max-width: 996px) {
-  .docItemContainer {
-    padding: 0 0.3rem;
-  }
-}

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

@@ -1,98 +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 {
-  --doc-sidebar-width: 300px;
-}
-
-:global(.docs-wrapper) {
-  display: flex;
-}
-
-.docPage,
-.docMainContainer {
-  display: flex;
-  width: 100%;
-}
-
-@media (min-width: 997px) {
-  .docMainContainer {
-    flex-grow: 1;
-    max-width: calc(100% - var(--doc-sidebar-width));
-  }
-
-  .docMainContainerEnhanced {
-    max-width: none;
-  }
-
-  .docSidebarContainer {
-    width: var(--doc-sidebar-width);
-    margin-top: calc(-1 * var(--ifm-navbar-height));
-    border-right: 1px solid var(--ifm-toc-border-color);
-    will-change: width;
-    transition: width var(--ifm-transition-fast) ease;
-    clip-path: inset(0);
-  }
-
-  .docSidebarContainerHidden {
-    width: 30px;
-    cursor: pointer;
-  }
-
-  .collapsedDocSidebar {
-    position: sticky;
-    top: 0;
-    height: 100%;
-    max-height: 100vh;
-    display: flex;
-    align-items: center;
-    justify-content: center;
-    transition: background-color var(--ifm-transition-fast) ease;
-  }
-
-  .collapsedDocSidebar:hover,
-  .collapsedDocSidebar:focus {
-    background-color: var(--ifm-color-emphasis-200);
-  }
-
-  .expandSidebarButtonIcon {
-    transform: rotate(0);
-  }
-  html[dir='rtl'] .expandSidebarButtonIcon {
-    transform: rotate(180deg);
-  }
-
-  html[data-theme='dark'] .collapsedDocSidebar:hover,
-  html[data-theme='dark'] .collapsedDocSidebar:focus {
-    background-color: var(--collapse-button-bg-color-dark);
-  }
-
-  .docItemWrapperEnhanced {
-    max-width: calc(var(--ifm-container-width) + var(--doc-sidebar-width)) !important;
-  }
-}
-
-@media (max-width: 996px) {
-  .docSidebarContainer {
-    margin-top: 0;
-  }
-}
-
-@media (min-width: 997px) and (max-width: 1320px) {
-  .docItemWrapper {
-    max-width: calc(
-      var(--ifm-container-width) - var(--doc-sidebar-width) -
-        var(--ifm-spacing-horizontal) * 2
-    );
-  }
-
-  .docItemWrapperEnhanced {
-    max-width: calc(
-      var(--ifm-container-width) - var(--ifm-spacing-horizontal) * 2
-    );
-  }
-}

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

@@ -1,138 +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;
-}
-
-.menuLinkExternal {
-  align-items: center;
-}
-.menuLinkExternal:after {
-  content: '';
-  height: 1.15rem;
-  width: 1.15rem;
-  min-width: 1.15rem;
-  margin: 0 0 0 3%;
-  background: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' viewBox='0 0 24 24'%3E%3Cpath fill='rgba(0,0,0,0.5)' d='M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z'/%3E%3C/svg%3E")
-    no-repeat;
-  filter: var(--ifm-menu-link-sublist-icon-filter);
-}

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: <strong>{versionLabel}</strong>
-  }}>
-      {'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: <strong>{versionLabel}</strong>
-  }}>
-      {'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: <strong>
-            <_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>
-          </strong>
-  }}>
-      {'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;