@docusaurus/theme-classic 2.0.0-beta.fc64c12e4 → 2.0.0

package/src/__tests__/validateThemeConfig.test.js

@@ -1,457 +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',
-              },
-            ],
-          },
-          // Dropdown with name
-          {
-            type: 'dropdown',
-            label: 'Tools',
-            position: 'left',
-            items: [
-              {
-                type: 'doc',
-                activeSidebarClassName: 'custom-class',
-                docId: 'npm',
-                label: 'NPM',
-              },
-              {
-                to: '/yarn',
-                label: 'Yarn',
-              },
-            ],
-          },
-          // 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 reject unknown navbar item type', () => {
-    const config = {
-      navbar: {
-        items: [
-          {
-            type: 'joke',
-            position: 'left',
-            label: 'haha',
-          },
-        ],
-      },
-    };
-    expect(() =>
-      testValidateThemeConfig(config),
-    ).toThrowErrorMatchingInlineSnapshot(`"Bad navbar item type joke"`);
-  });
-
-  test('should reject nested dropdowns', () => {
-    const config = {
-      navbar: {
-        items: [
-          {
-            position: 'left',
-            label: 'Nested',
-            items: [
-              {
-                label: 'Still a dropdown',
-                items: [
-                  {
-                    label: 'Should reject this',
-                    to: '/rejected',
-                  },
-                ],
-              },
-            ],
-          },
-        ],
-      },
-    };
-    expect(() =>
-      testValidateThemeConfig(config),
-    ).toThrowErrorMatchingInlineSnapshot(`"Nested dropdowns are not allowed"`);
-  });
-
-  test('should reject nested dropdowns', () => {
-    const config = {
-      navbar: {
-        items: [
-          {
-            position: 'left',
-            label: 'Nested',
-            items: [{type: 'docsVersionDropdown'}],
-          },
-        ],
-      },
-    };
-    expect(() =>
-      testValidateThemeConfig(config),
-    ).toThrowErrorMatchingInlineSnapshot(`"Nested dropdowns are not allowed"`);
-  });
-
-  test('should reject position attribute within dropdown', () => {
-    const config = {
-      navbar: {
-        items: [
-          {
-            position: 'left',
-            label: 'Dropdown',
-            items: [
-              {
-                label: 'Hi',
-                position: 'left',
-                to: '/link',
-              },
-            ],
-          },
-        ],
-      },
-    };
-    expect(() =>
-      testValidateThemeConfig(config),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"\\"navbar.items[0].items[0].position\\" is not allowed"`,
-    );
-  });
-
-  test('should give friendly error when href and to coexist', () => {
-    const config = {
-      navbar: {
-        items: [
-          {
-            position: 'left',
-            label: 'Nested',
-            to: '/link',
-            href: 'http://example.com/link',
-          },
-        ],
-      },
-    };
-    expect(() =>
-      testValidateThemeConfig(config),
-    ).toThrowErrorMatchingInlineSnapshot(
-      `"One and only one between \\"to\\" and \\"href\\" should be provided"`,
-    );
-  });
-
-  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/src/prism-include-languages.js

@@ -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.
- */
-
-import Prism from 'prism-react-renderer/prism';
-import prismIncludeLanguages from '@theme/prism-include-languages';
-
-prismIncludeLanguages(Prism);

package/src/theme/BlogSidebar/styles.module.css

@@ -1,44 +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.
- */
-
-.sidebar {
-  max-height: calc(100vh - (var(--ifm-navbar-height) + 2rem));
-  overflow-y: auto;
-  position: sticky;
-  top: calc(var(--ifm-navbar-height) + 2rem);
-}
-
-.sidebarItemTitle {
-  font-size: var(--ifm-h3-font-size);
-  font-weight: var(--ifm-font-weight-bold);
-}
-
-.sidebarItemList {
-  list-style: none;
-  font-size: 0.9rem;
-  padding-left: 0;
-}
-
-.sidebarItem {
-  margin-top: 0.7rem;
-}
-
-.sidebarItemLink {
-  color: var(--ifm-font-color-base);
-}
-.sidebarItemLink:hover {
-  text-decoration: none;
-}
-.sidebarItemLinkActive {
-  color: var(--ifm-color-primary);
-}
-
-@media only screen and (max-width: 996px) {
-  .sidebar {
-    display: none;
-  }
-}

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

@@ -1,66 +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);
-  border-radius: var(--ifm-global-radius);
-  box-shadow: var(--ifm-global-shadow-lw);
-  overflow: hidden;
-}
-
-.codeBlockContent {
-  position: relative;
-  /*rtl:ignore*/
-  direction: ltr;
-}
-
-.codeBlockTitle {
-  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 {
-  margin: 0;
-  padding: 0;
-  border-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/src/theme/DocItem/styles.module.css

@@ -1,32 +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 article *:first-child,
-.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/src/theme/DocPage/styles.module.css

@@ -1,85 +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;
-  --doc-sidebar-hidden-width: 30px;
-}
-
-:global(.docs-wrapper) {
-  display: flex;
-}
-
-.docPage,
-.docMainContainer {
-  display: flex;
-  width: 100%;
-}
-
-.docSidebarContainer {
-  display: none;
-}
-
-@media (min-width: 997px) {
-  .docMainContainer {
-    flex-grow: 1;
-    max-width: calc(100% - var(--doc-sidebar-width));
-  }
-
-  .docMainContainerEnhanced {
-    max-width: calc(100% - var(--doc-sidebar-hidden-width));
-  }
-
-  .docSidebarContainer {
-    display: block;
-    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: var(--doc-sidebar-hidden-width);
-    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;
-  }
-}