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

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/AnnouncementBar/index.js

@@ -1,74 +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 _themeCommon = require("@docusaurus/theme-common");
-
-var _useUserPreferencesContext = _interopRequireDefault(require("@theme/hooks/useUserPreferencesContext"));
-
-var _Translate = require("@docusaurus/Translate");
-
-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 AnnouncementBar() {
-  const {
-    isAnnouncementBarClosed,
-    closeAnnouncementBar
-  } = (0, _useUserPreferencesContext.default)();
-  const {
-    announcementBar
-  } = (0, _themeCommon.useThemeConfig)();
-
-  if (!announcementBar) {
-    return null;
-  }
-
-  const {
-    content,
-    backgroundColor,
-    textColor,
-    isCloseable
-  } = announcementBar;
-
-  if (!content || isCloseable && isAnnouncementBarClosed) {
-    return null;
-  }
-
-  return <div className={_stylesModule.default.announcementBar} style={{
-    backgroundColor,
-    color: textColor
-  }} role="banner">
-      <div className={(0, _clsx.default)(_stylesModule.default.announcementBarContent, {
-      [_stylesModule.default.announcementBarCloseable]: isCloseable
-    })} // Developer provided the HTML, so assume it's safe.
-    // eslint-disable-next-line react/no-danger
-    dangerouslySetInnerHTML={{
-      __html: content
-    }} />
-      {isCloseable ? <button type="button" className={_stylesModule.default.announcementBarClose} onClick={closeAnnouncementBar} aria-label={(0, _Translate.translate)({
-      id: 'theme.AnnouncementBar.closeButtonAriaLabel',
-      message: 'Close',
-      description: 'The ARIA label for close button of announcement bar'
-    })}>
-          <span aria-hidden="true">×</span>
-        </button> : null}
-    </div>;
-}
-
-var _default = AnnouncementBar;
-exports.default = _default;

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

@@ -1,72 +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 {
-  --docusaurus-announcement-bar-height: auto;
-}
-
-.announcementBar {
-  position: relative;
-  width: 100%;
-  height: var(--docusaurus-announcement-bar-height);
-  background-color: var(--ifm-color-primary);
-  color: var(--ifm-color-black);
-}
-
-@media print {
-  .announcementBar {
-    display: none;
-  }
-}
-
-@media screen and (min-width: 1024px) {
-  :root {
-    --docusaurus-announcement-bar-height: 30px;
-  }
-}
-
-.announcementBarClose {
-  position: absolute;
-  right: 0;
-  top: 0;
-  width: 55px;
-  font-size: 1.25rem;
-  padding: 0;
-  border: none;
-  cursor: pointer;
-  background: none;
-  color: inherit;
-  height: 100%;
-}
-
-.announcementBarContent {
-  font-size: 85%;
-  width: 100%;
-  text-align: center;
-  padding: 5px 0;
-}
-
-.announcementBarCloseable {
-  margin-right: 55px;
-}
-
-@media screen and (max-width: 576px) {
-  .announcementBarClose {
-    width: 35px;
-  }
-  .announcementBarContent {
-    width: auto;
-  }
-  .announcementBarCloseable {
-    margin-right: 35px;
-  }
-}
-
-.announcementBarContent a {
-  color: inherit;
-  text-decoration: underline;
-}

package/lib/theme/BlogListPage/index.js

@@ -1,71 +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 _Layout = _interopRequireDefault(require("@theme/Layout"));
-
-var _BlogPostItem = _interopRequireDefault(require("@theme/BlogPostItem"));
-
-var _BlogListPaginator = _interopRequireDefault(require("@theme/BlogListPaginator"));
-
-var _BlogSidebar = _interopRequireDefault(require("@theme/BlogSidebar"));
-
-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 BlogListPage(props) {
-  const {
-    metadata,
-    items,
-    sidebar
-  } = props;
-  const {
-    siteConfig: {
-      title: siteTitle
-    }
-  } = (0, _useDocusaurusContext.default)();
-  const {
-    blogDescription,
-    blogTitle,
-    permalink
-  } = metadata;
-  const isBlogOnlyMode = permalink === '/';
-  const title = isBlogOnlyMode ? siteTitle : blogTitle;
-  return <_Layout.default title={title} description={blogDescription} wrapperClassName={_themeCommon.ThemeClassNames.wrapper.blogPages} pageClassName={_themeCommon.ThemeClassNames.page.blogListPage} searchMetadatas={{
-    // assign unique search tag to exclude this page from search results!
-    tag: 'blog_posts_list'
-  }}>
-      <div className="container margin-vert--lg">
-        <div className="row">
-          <div className="col col--3">
-            <_BlogSidebar.default sidebar={sidebar} />
-          </div>
-          <main className="col col--7">
-            {items.map(({
-            content: BlogPostContent
-          }) => <_BlogPostItem.default key={BlogPostContent.metadata.permalink} frontMatter={BlogPostContent.frontMatter} metadata={BlogPostContent.metadata} truncated={BlogPostContent.metadata.truncated}>
-                <BlogPostContent />
-              </_BlogPostItem.default>)}
-            <_BlogListPaginator.default metadata={metadata} />
-          </main>
-        </div>
-      </div>
-    </_Layout.default>;
-}
-
-var _default = BlogListPage;
-exports.default = _default;

package/lib/theme/BlogListPaginator/index.js

@@ -1,63 +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 _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
-
-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; }
-
-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 BlogListPaginator(props) {
-  const {
-    metadata
-  } = props;
-  const {
-    previousPage,
-    nextPage
-  } = metadata;
-  return <nav className="pagination-nav" aria-label={(0, _Translate.translate)({
-    id: 'theme.blog.paginator.navAriaLabel',
-    message: 'Blog list page navigation',
-    description: 'The ARIA label for the blog pagination'
-  })}>
-      <div className="pagination-nav__item">
-        {previousPage && <_Link.default className="pagination-nav__link" to={previousPage}>
-            <div className="pagination-nav__label">
-              &laquo;{' '}
-              <_Translate.default id="theme.blog.paginator.newerEntries" description="The label used to navigate to the newer blog posts page (previous page)">
-                Newer Entries
-              </_Translate.default>
-            </div>
-          </_Link.default>}
-      </div>
-      <div className="pagination-nav__item pagination-nav__item--next">
-        {nextPage && <_Link.default className="pagination-nav__link" to={nextPage}>
-            <div className="pagination-nav__label">
-              <_Translate.default id="theme.blog.paginator.olderEntries" description="The label used to navigate to the older blog posts page (next page)">
-                Older Entries
-              </_Translate.default>{' '}
-              &raquo;
-            </div>
-          </_Link.default>}
-      </div>
-    </nav>;
-}
-
-var _default = BlogListPaginator;
-exports.default = _default;