@docusaurus/theme-classic 2.0.0-beta.1ec2c95e3 → 2.0.0-beta.21

package/lib/validateThemeConfig.js

@@ -1,317 +1,400 @@
+"use strict";
 /**
  * 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 {Joi, URISchema} = require('@docusaurus/utils-validation');
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateThemeConfig = exports.ThemeConfigSchema = exports.DEFAULT_CONFIG = void 0;
+const tslib_1 = require("tslib");
+const palenight_1 = tslib_1.__importDefault(require("prism-react-renderer/themes/palenight"));
+const utils_validation_1 = require("@docusaurus/utils-validation");
 const DEFAULT_DOCS_CONFIG = {
-  versionPersistence: 'localStorage',
+    versionPersistence: 'localStorage',
+    sidebar: {
+        hideable: false,
+        autoCollapseCategories: false,
+    },
 };
-const DocsSchema = Joi.object({
-  versionPersistence: Joi.string()
-    .equal('localStorage', 'none')
-    .default(DEFAULT_DOCS_CONFIG.versionPersistence),
+const DocsSchema = utils_validation_1.Joi.object({
+    versionPersistence: utils_validation_1.Joi.string()
+        .equal('localStorage', 'none')
+        .default(DEFAULT_DOCS_CONFIG.versionPersistence),
+    sidebar: utils_validation_1.Joi.object({
+        hideable: utils_validation_1.Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.hideable),
+        autoCollapseCategories: utils_validation_1.Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.autoCollapseCategories),
+    }).default(DEFAULT_DOCS_CONFIG.sidebar),
 }).default(DEFAULT_DOCS_CONFIG);
-
 const DEFAULT_COLOR_MODE_CONFIG = {
-  defaultMode: 'light',
-  disableSwitch: false,
-  respectPrefersColorScheme: false,
-  switchConfig: {
-    darkIcon: '🌜',
-    darkIconStyle: {},
-    lightIcon: '🌞',
-    lightIconStyle: {},
-  },
+    defaultMode: 'light',
+    disableSwitch: false,
+    respectPrefersColorScheme: false,
 };
-
-const DEFAULT_CONFIG = {
-  colorMode: DEFAULT_COLOR_MODE_CONFIG,
-  docs: DEFAULT_DOCS_CONFIG,
-  metadatas: [],
-  prism: {
-    additionalLanguages: [],
-  },
-  navbar: {
-    hideOnScroll: false,
-    items: [],
-  },
-  hideableSidebar: false,
+exports.DEFAULT_CONFIG = {
+    colorMode: DEFAULT_COLOR_MODE_CONFIG,
+    docs: DEFAULT_DOCS_CONFIG,
+    metadata: [],
+    prism: {
+        additionalLanguages: [],
+        theme: palenight_1.default,
+        magicComments: [
+            {
+                className: 'theme-code-block-highlighted-line',
+                line: 'highlight-next-line',
+                block: { start: 'highlight-start', end: 'highlight-end' },
+            },
+        ],
+    },
+    navbar: {
+        hideOnScroll: false,
+        items: [],
+    },
+    tableOfContents: {
+        minHeadingLevel: 2,
+        maxHeadingLevel: 3,
+    },
 };
-exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
-
-const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
-
-const BaseNavbarItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  label: Joi.string(),
-  className: Joi.string(),
-  prependBaseUrlToHref: Joi.bool(),
+const NavbarItemPosition = utils_validation_1.Joi.string().equal('left', 'right').default('left');
+const NavbarItemBaseSchema = utils_validation_1.Joi.object({
+    label: utils_validation_1.Joi.string(),
+    html: utils_validation_1.Joi.string(),
+    className: utils_validation_1.Joi.string(),
 })
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-
-// TODO we should probably create a custom navbar item type "dropdown"
-// having this recursive structure is bad because we only support 2 levels
-// + parent/child don't have exactly the same props
-const DefaultNavbarItemSchema = BaseNavbarItemSchema.append({
-  items: Joi.array().optional().items(BaseNavbarItemSchema),
-  position: NavbarItemPosition,
-  activeBasePath: Joi.string(),
-  activeBaseRegex: Joi.string(),
-});
-// TODO the dropdown parent item can have no href/to
-// should check should not apply to dropdown parent item
-// .xor('href', 'to');
-
-const DocsVersionNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('docsVersion').required(),
-  position: NavbarItemPosition,
-  label: Joi.string(),
-  to: Joi.string(),
-  docsPluginId: Joi.string(),
-  className: Joi.string(),
+    .nand('html', 'label')
+    // We allow any unknown attributes on the links (users may need additional
+    // attributes like target, aria-role, data-customAttribute...)
+    .unknown();
+const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
+    to: utils_validation_1.Joi.string(),
+    href: utils_validation_1.URISchema,
+    activeBasePath: utils_validation_1.Joi.string(),
+    activeBaseRegex: utils_validation_1.Joi.string(),
+    prependBaseUrlToHref: utils_validation_1.Joi.bool(),
+    // This is only triggered in case of a nested dropdown
+    items: utils_validation_1.Joi.forbidden().messages({
+        'any.unknown': 'Nested dropdowns are not allowed',
+    }),
+})
+    .xor('href', 'to')
+    .messages({
+    'object.xor': 'One and only one between "to" and "href" should be provided',
 });
-
-const DocsVersionDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('docsVersionDropdown').required(),
-  position: NavbarItemPosition,
-  docsPluginId: Joi.string(),
-  dropdownActiveClassDisabled: Joi.boolean(),
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
+const DocsVersionNavbarItemSchema = NavbarItemBaseSchema.append({
+    type: utils_validation_1.Joi.string().equal('docsVersion').required(),
+    to: utils_validation_1.Joi.string(),
+    docsPluginId: utils_validation_1.Joi.string(),
 });
-
-const DocItemSchema = Joi.object({
-  type: Joi.string().equal('doc').required(),
-  position: NavbarItemPosition,
-  docId: Joi.string().required(),
-  label: Joi.string(),
-  docsPluginId: Joi.string(),
-  activeSidebarClassName: Joi.string().default('navbar__link--active'),
-  className: Joi.string(),
+const DocItemSchema = NavbarItemBaseSchema.append({
+    type: utils_validation_1.Joi.string().equal('doc').required(),
+    docId: utils_validation_1.Joi.string().required(),
+    docsPluginId: utils_validation_1.Joi.string(),
 });
-
-const LocaleDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('localeDropdown').required(),
-  position: NavbarItemPosition,
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
+const DocSidebarItemSchema = NavbarItemBaseSchema.append({
+    type: utils_validation_1.Joi.string().equal('docSidebar').required(),
+    sidebarId: utils_validation_1.Joi.string().required(),
+    docsPluginId: utils_validation_1.Joi.string(),
 });
-
-const SearchItemSchema = Joi.object({
-  type: Joi.string().equal('search').required(),
-  position: NavbarItemPosition,
+const HtmlNavbarItemSchema = utils_validation_1.Joi.object({
+    className: utils_validation_1.Joi.string(),
+    type: utils_validation_1.Joi.string().equal('html').required(),
+    value: utils_validation_1.Joi.string().required(),
 });
-
-// Can this be made easier? :/
-const isOfType = (type) => {
-  let typeSchema = Joi.string().required();
-  // because equal(undefined) is not supported :/
-  if (type) {
-    typeSchema = typeSchema.equal(type);
-  }
-  return Joi.object({
-    type: typeSchema,
-  })
-    .unknown()
-    .required();
+// A temporary workaround to allow users to add custom navbar items
+// See https://github.com/facebook/docusaurus/issues/7227
+const CustomNavbarItemRegexp = /custom-.*/;
+const CustomNavbarItemSchema = utils_validation_1.Joi.object({
+    type: utils_validation_1.Joi.string().regex(CustomNavbarItemRegexp).required(),
+}).unknown();
+const itemWithType = (type) => {
+    // Because equal(undefined) is not supported :/
+    const typeSchema = 
+    // eslint-disable-next-line no-nested-ternary
+    type instanceof RegExp
+        ? utils_validation_1.Joi.string().required().regex(type)
+        : type
+            ? utils_validation_1.Joi.string().required().equal(type)
+            : utils_validation_1.Joi.string().forbidden();
+    return utils_validation_1.Joi.object({
+        type: typeSchema,
+    })
+        .unknown()
+        .required();
 };
-
-const NavbarItemSchema = Joi.object().when({
-  switch: [
-    {
-      is: isOfType('docsVersion'),
-      then: DocsVersionNavbarItemSchema,
-    },
-    {
-      is: isOfType('docsVersionDropdown'),
-      then: DocsVersionDropdownNavbarItemSchema,
-    },
-    {
-      is: isOfType('doc'),
-      then: DocItemSchema,
-    },
-    {
-      is: isOfType('localeDropdown'),
-      then: LocaleDropdownNavbarItemSchema,
-    },
-    {
-      is: isOfType('search'),
-      then: SearchItemSchema,
-    },
-    {
-      is: isOfType(undefined),
-      then: Joi.forbidden().messages({
+const DropdownSubitemSchema = utils_validation_1.Joi.object({
+    position: utils_validation_1.Joi.forbidden(),
+}).when('.', {
+    switch: [
+        {
+            is: itemWithType('docsVersion'),
+            then: DocsVersionNavbarItemSchema,
+        },
+        {
+            is: itemWithType('doc'),
+            then: DocItemSchema,
+        },
+        {
+            is: itemWithType('docSidebar'),
+            then: DocSidebarItemSchema,
+        },
+        {
+            is: itemWithType(undefined),
+            then: DefaultNavbarItemSchema,
+        },
+        {
+            is: itemWithType('html'),
+            then: HtmlNavbarItemSchema,
+        },
+        {
+            is: itemWithType(CustomNavbarItemRegexp),
+            then: CustomNavbarItemSchema,
+        },
+        {
+            is: utils_validation_1.Joi.alternatives().try(itemWithType('dropdown'), itemWithType('docsVersionDropdown'), itemWithType('localeDropdown'), itemWithType('search')),
+            then: utils_validation_1.Joi.forbidden().messages({
+                'any.unknown': 'Nested dropdowns are not allowed',
+            }),
+        },
+    ],
+    otherwise: utils_validation_1.Joi.forbidden().messages({
         'any.unknown': 'Bad navbar item type {.type}',
-      }),
-    },
-  ],
-  otherwise: DefaultNavbarItemSchema,
+    }),
 });
-
-/*
-const NavbarItemSchema = Joi.object({
-  type: Joi.string().only(['docsVersion'])
-})
-  .when(Joi.object({ type: 'docsVersion' }).unknown(), {
-    then: Joi.object({ pepperoni: Joi.boolean() })
-  })
-  .when(Joi.object().unknown(), {
-    then: Joi.object({ croutons: Joi.boolean() })
-  })
-
- */
-
-/*
-const NavbarItemSchema = Joi.object().when('type', {
-  is: Joi.valid('docsVersion'),
-  then: DocsVersionNavbarItemSchema,
-  otherwise: DefaultNavbarItemSchema,
+const DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+    items: utils_validation_1.Joi.array().items(DropdownSubitemSchema).required(),
 });
- */
-
-const ColorModeSchema = Joi.object({
-  defaultMode: Joi.string()
-    .equal('dark', 'light')
-    .default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
-  disableSwitch: Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
-  respectPrefersColorScheme: Joi.bool().default(
-    DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme,
-  ),
-  switchConfig: Joi.object({
-    darkIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIcon,
-    ),
-    darkIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.darkIconStyle,
-    ),
-    lightIcon: Joi.string().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIcon,
-    ),
-    lightIconStyle: Joi.object().default(
-      DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIconStyle,
-    ),
-  }).default(DEFAULT_COLOR_MODE_CONFIG.switchConfig),
+const DocsVersionDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+    type: utils_validation_1.Joi.string().equal('docsVersionDropdown').required(),
+    docsPluginId: utils_validation_1.Joi.string(),
+    dropdownActiveClassDisabled: utils_validation_1.Joi.boolean(),
+    dropdownItemsBefore: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
+    dropdownItemsAfter: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
+});
+const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+    type: utils_validation_1.Joi.string().equal('localeDropdown').required(),
+    dropdownItemsBefore: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
+    dropdownItemsAfter: utils_validation_1.Joi.array().items(DropdownSubitemSchema).default([]),
+});
+const SearchItemSchema = utils_validation_1.Joi.object({
+    type: utils_validation_1.Joi.string().equal('search').required(),
+    className: utils_validation_1.Joi.string(),
+});
+const NavbarItemSchema = utils_validation_1.Joi.object({
+    position: NavbarItemPosition,
+}).when('.', {
+    switch: [
+        {
+            is: itemWithType('docsVersion'),
+            then: DocsVersionNavbarItemSchema,
+        },
+        {
+            is: itemWithType('dropdown'),
+            then: DropdownNavbarItemSchema,
+        },
+        {
+            is: itemWithType('docsVersionDropdown'),
+            then: DocsVersionDropdownNavbarItemSchema,
+        },
+        {
+            is: itemWithType('doc'),
+            then: DocItemSchema,
+        },
+        {
+            is: itemWithType('docSidebar'),
+            then: DocSidebarItemSchema,
+        },
+        {
+            is: itemWithType('localeDropdown'),
+            then: LocaleDropdownNavbarItemSchema,
+        },
+        {
+            is: itemWithType('search'),
+            then: SearchItemSchema,
+        },
+        {
+            is: itemWithType('html'),
+            then: HtmlNavbarItemSchema,
+        },
+        {
+            is: itemWithType(CustomNavbarItemRegexp),
+            then: CustomNavbarItemSchema,
+        },
+        {
+            is: itemWithType(undefined),
+            then: utils_validation_1.Joi.object().when('.', {
+                // Dropdown item can be specified without type field
+                is: utils_validation_1.Joi.object({
+                    items: utils_validation_1.Joi.array().required(),
+                }).unknown(),
+                then: DropdownNavbarItemSchema,
+                otherwise: DefaultNavbarItemSchema,
+            }),
+        },
+    ],
+    otherwise: utils_validation_1.Joi.forbidden().messages({
+        'any.unknown': 'Bad navbar item type {.type}',
+    }),
+});
+const ColorModeSchema = utils_validation_1.Joi.object({
+    defaultMode: utils_validation_1.Joi.string()
+        .equal('dark', 'light')
+        .default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
+    disableSwitch: utils_validation_1.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
+    respectPrefersColorScheme: utils_validation_1.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme),
+    switchConfig: utils_validation_1.Joi.any().forbidden().messages({
+        'any.unknown': 'colorMode.switchConfig is deprecated. If you want to customize the icons for light and dark mode, swizzle IconLightMode, IconDarkMode, or ColorModeToggle instead.',
+    }),
 }).default(DEFAULT_COLOR_MODE_CONFIG);
-
-// schema can probably be improved
-const HtmlMetadataSchema = Joi.object({
-  id: Joi.string(),
-  name: Joi.string(),
-  property: Joi.string(),
-  content: Joi.string(),
-  itemprop: Joi.string(),
+const HtmlMetadataSchema = utils_validation_1.Joi.object({
+    id: utils_validation_1.Joi.string(),
+    name: utils_validation_1.Joi.string(),
+    property: utils_validation_1.Joi.string(),
+    content: utils_validation_1.Joi.string(),
+    itemprop: utils_validation_1.Joi.string(),
 }).unknown();
-
-const FooterLinkItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  html: Joi.string(),
-  label: Joi.string(),
+const FooterLinkItemSchema = utils_validation_1.Joi.object({
+    to: utils_validation_1.Joi.string(),
+    href: utils_validation_1.URISchema,
+    html: utils_validation_1.Joi.string(),
+    label: utils_validation_1.Joi.string(),
 })
-  .xor('to', 'href', 'html')
-  .with('to', 'label')
-  .with('href', 'label')
-  .nand('html', 'label')
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
-
-const CustomCssSchema = Joi.alternatives()
-  .try(Joi.array().items(Joi.string().required()), Joi.string().required())
-  .optional();
-
-const ThemeConfigSchema = Joi.object({
-  // TODO temporary (@alpha-58)
-  disableDarkMode: Joi.any().forbidden(false).messages({
-    'any.unknown':
-      'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
-  }),
-  // TODO temporary (@alpha-58)
-  defaultDarkMode: Joi.any().forbidden(false).messages({
-    'any.unknown':
-      'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
-  }),
-  customCss: CustomCssSchema,
-  colorMode: ColorModeSchema,
-  image: Joi.string(),
-  docs: DocsSchema,
-  metadatas: Joi.array()
-    .items(HtmlMetadataSchema)
-    .default(DEFAULT_CONFIG.metadatas),
-  announcementBar: Joi.object({
-    id: Joi.string().default('announcement-bar'),
-    content: Joi.string(),
-    backgroundColor: Joi.string(),
-    textColor: Joi.string(),
-    isCloseable: Joi.bool().default(true),
-  }).optional(),
-  navbar: Joi.object({
-    style: Joi.string().equal('dark', 'primary'),
-    hideOnScroll: Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
+    .xor('to', 'href', 'html')
+    .with('to', 'label')
+    .with('href', 'label')
+    .nand('html', 'label')
+    // We allow any unknown attributes on the links (users may need additional
+    // attributes like target, aria-role, data-customAttribute...)
+    .unknown();
+const CustomCssSchema = utils_validation_1.Joi.alternatives()
+    .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required()), utils_validation_1.Joi.string().required())
+    .optional();
+exports.ThemeConfigSchema = utils_validation_1.Joi.object({
     // TODO temporary (@alpha-58)
-    links: Joi.any().forbidden().messages({
-      'any.unknown':
-        'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
+    // @ts-expect-error: forbidden
+    disableDarkMode: utils_validation_1.Joi.any().forbidden().messages({
+        'any.unknown': 'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
     }),
-    items: Joi.array()
-      .items(NavbarItemSchema)
-      .default(DEFAULT_CONFIG.navbar.items),
-    title: Joi.string().allow('', null),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string().required(),
-      srcDark: Joi.string(),
-      href: Joi.string(),
-      target: Joi.string(),
+    // TODO temporary (@alpha-58)
+    defaultDarkMode: utils_validation_1.Joi.any().forbidden().messages({
+        'any.unknown': 'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
     }),
-  }).default(DEFAULT_CONFIG.navbar),
-  footer: Joi.object({
-    style: Joi.string().equal('dark', 'light').default('light'),
-    logo: Joi.object({
-      alt: Joi.string().allow(''),
-      src: Joi.string(),
-      srcDark: Joi.string(),
-      href: Joi.string(),
+    customCss: CustomCssSchema,
+    colorMode: ColorModeSchema,
+    image: utils_validation_1.Joi.string(),
+    docs: DocsSchema,
+    metadata: utils_validation_1.Joi.array()
+        .items(HtmlMetadataSchema)
+        .default(exports.DEFAULT_CONFIG.metadata),
+    // cSpell:ignore metadatas
+    metadatas: utils_validation_1.Joi.any().forbidden().messages({
+        'any.unknown': 
+        // cSpell:ignore metadatas
+        'themeConfig.metadatas has been renamed as themeConfig.metadata. See https://github.com/facebook/docusaurus/pull/5871',
     }),
-    copyright: Joi.string(),
-    links: Joi.array()
-      .items(
-        Joi.object({
-          title: Joi.string().allow(null),
-          items: Joi.array().items(FooterLinkItemSchema).default([]),
+    announcementBar: utils_validation_1.Joi.object({
+        id: utils_validation_1.Joi.string().default('announcement-bar'),
+        content: utils_validation_1.Joi.string().required(),
+        backgroundColor: utils_validation_1.Joi.string(),
+        textColor: utils_validation_1.Joi.string(),
+        isCloseable: utils_validation_1.Joi.bool().default(true),
+    }).optional(),
+    navbar: utils_validation_1.Joi.object({
+        style: utils_validation_1.Joi.string().equal('dark', 'primary'),
+        hideOnScroll: utils_validation_1.Joi.bool().default(exports.DEFAULT_CONFIG.navbar.hideOnScroll),
+        // TODO temporary (@alpha-58)
+        links: utils_validation_1.Joi.any().forbidden().messages({
+            'any.unknown': 'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
+        }),
+        items: utils_validation_1.Joi.array()
+            .items(NavbarItemSchema)
+            .default(exports.DEFAULT_CONFIG.navbar.items),
+        title: utils_validation_1.Joi.string().allow('', null),
+        logo: utils_validation_1.Joi.object({
+            alt: utils_validation_1.Joi.string().allow(''),
+            src: utils_validation_1.Joi.string().required(),
+            srcDark: utils_validation_1.Joi.string(),
+            width: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
+            height: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
+            href: utils_validation_1.Joi.string(),
+            target: utils_validation_1.Joi.string(),
+        }),
+    }).default(exports.DEFAULT_CONFIG.navbar),
+    footer: utils_validation_1.Joi.object({
+        style: utils_validation_1.Joi.string().equal('dark', 'light').default('light'),
+        logo: utils_validation_1.Joi.object({
+            alt: utils_validation_1.Joi.string().allow(''),
+            src: utils_validation_1.Joi.string().required(),
+            srcDark: utils_validation_1.Joi.string(),
+            // TODO infer this from reading the image
+            width: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
+            height: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.string(), utils_validation_1.Joi.number()),
+            href: utils_validation_1.Joi.string(),
         }),
-      )
-      .default([]),
-  }).optional(),
-  prism: Joi.object({
-    theme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
+        copyright: utils_validation_1.Joi.string(),
+        links: utils_validation_1.Joi.alternatives(utils_validation_1.Joi.array().items(utils_validation_1.Joi.object({
+            title: utils_validation_1.Joi.string().allow(null).default(null),
+            items: utils_validation_1.Joi.array().items(FooterLinkItemSchema).default([]),
+        })), utils_validation_1.Joi.array().items(FooterLinkItemSchema))
+            .messages({
+            'alternatives.match': `The footer must be either simple or multi-column, and not a mix of the two. See: https://docusaurus.io/docs/api/themes/configuration#footer-links`,
+        })
+            .default([]),
+    }).optional(),
+    prism: utils_validation_1.Joi.object({
+        theme: utils_validation_1.Joi.object({
+            plain: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
+            styles: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
+        }).default(exports.DEFAULT_CONFIG.prism.theme),
+        darkTheme: utils_validation_1.Joi.object({
+            plain: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
+            styles: utils_validation_1.Joi.alternatives().try(utils_validation_1.Joi.array(), utils_validation_1.Joi.object()).required(),
+        }),
+        defaultLanguage: utils_validation_1.Joi.string(),
+        additionalLanguages: utils_validation_1.Joi.array()
+            .items(utils_validation_1.Joi.string())
+            .default(exports.DEFAULT_CONFIG.prism.additionalLanguages),
+        magicComments: utils_validation_1.Joi.array()
+            .items(utils_validation_1.Joi.object({
+            className: utils_validation_1.Joi.string().required(),
+            line: utils_validation_1.Joi.string(),
+            block: utils_validation_1.Joi.object({
+                start: utils_validation_1.Joi.string().required(),
+                end: utils_validation_1.Joi.string().required(),
+            }),
+        }).or('line', 'block'))
+            .default(exports.DEFAULT_CONFIG.prism.magicComments),
+    })
+        .default(exports.DEFAULT_CONFIG.prism)
+        .unknown(),
+    hideableSidebar: utils_validation_1.Joi.forbidden().messages({
+        'any.unknown': 'themeConfig.hideableSidebar has been moved to themeConfig.docs.sidebar.hideable.',
+    }),
+    autoCollapseSidebarCategories: utils_validation_1.Joi.forbidden().messages({
+        'any.unknown': 'themeConfig.autoCollapseSidebarCategories has been moved to themeConfig.docs.sidebar.autoCollapseCategories.',
     }),
-    darkTheme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
+    sidebarCollapsible: utils_validation_1.Joi.forbidden().messages({
+        'any.unknown': 'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs',
     }),
-    defaultLanguage: Joi.string(),
-    additionalLanguages: Joi.array()
-      .items(Joi.string())
-      .default(DEFAULT_CONFIG.prism.additionalLanguages),
-  })
-    .default(DEFAULT_CONFIG.prism)
-    .unknown(),
-  hideableSidebar: Joi.bool().default(DEFAULT_CONFIG.hideableSidebar),
+    tableOfContents: utils_validation_1.Joi.object({
+        minHeadingLevel: utils_validation_1.Joi.number()
+            .default(exports.DEFAULT_CONFIG.tableOfContents.minHeadingLevel)
+            .when('maxHeadingLevel', {
+            is: utils_validation_1.Joi.exist(),
+            then: utils_validation_1.Joi.number()
+                .integer()
+                .min(2)
+                .max(6)
+                .max(utils_validation_1.Joi.ref('maxHeadingLevel')),
+            otherwise: utils_validation_1.Joi.number().integer().min(2).max(6),
+        }),
+        maxHeadingLevel: utils_validation_1.Joi.number()
+            .integer()
+            .min(2)
+            .max(6)
+            .default(exports.DEFAULT_CONFIG.tableOfContents.maxHeadingLevel),
+    }).default(exports.DEFAULT_CONFIG.tableOfContents),
 });
-exports.ThemeConfigSchema = ThemeConfigSchema;
-
-exports.validateThemeConfig = ({validate, themeConfig}) => {
-  return validate(ThemeConfigSchema, themeConfig);
-};
+function validateThemeConfig({ validate, themeConfig, }) {
+    return validate(exports.ThemeConfigSchema, themeConfig);
+}
+exports.validateThemeConfig = validateThemeConfig;