@docusaurus/theme-classic 2.0.0-beta.2 → 2.0.0-beta.20

package/lib/validateThemeConfig.js

@@ -1,317 +1,367 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ThemeConfigSchema = exports.DEFAULT_CONFIG = void 0;
+exports.validateThemeConfig = validateThemeConfig;
+
+var _palenight = _interopRequireDefault(require("prism-react-renderer/themes/palenight"));
+
+var _utilsValidation = require("@docusaurus/utils-validation");
+
+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.
  */
-
-const {Joi, URISchema} = require('@docusaurus/utils-validation');
-
 const DEFAULT_DOCS_CONFIG = {
   versionPersistence: 'localStorage',
+  sidebar: {
+    hideable: false,
+    autoCollapseCategories: false
+  }
 };
-const DocsSchema = Joi.object({
-  versionPersistence: Joi.string()
-    .equal('localStorage', 'none')
-    .default(DEFAULT_DOCS_CONFIG.versionPersistence),
+
+const DocsSchema = _utilsValidation.Joi.object({
+  versionPersistence: _utilsValidation.Joi.string().equal('localStorage', 'none').default(DEFAULT_DOCS_CONFIG.versionPersistence),
+  sidebar: _utilsValidation.Joi.object({
+    hideable: _utilsValidation.Joi.bool().default(DEFAULT_DOCS_CONFIG.sidebar.hideable),
+    autoCollapseCategories: _utilsValidation.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: {},
-  },
+  respectPrefersColorScheme: false
 };
-
 const DEFAULT_CONFIG = {
   colorMode: DEFAULT_COLOR_MODE_CONFIG,
   docs: DEFAULT_DOCS_CONFIG,
-  metadatas: [],
+  metadata: [],
   prism: {
     additionalLanguages: [],
+    theme: _palenight.default,
+    magicComments: [{
+      className: 'theme-code-block-highlighted-line',
+      line: 'highlight-next-line',
+      block: {
+        start: 'highlight-start',
+        end: 'highlight-end'
+      }
+    }]
   },
   navbar: {
     hideOnScroll: false,
-    items: [],
+    items: []
   },
-  hideableSidebar: false,
+  tableOfContents: {
+    minHeadingLevel: 2,
+    maxHeadingLevel: 3
+  }
 };
 exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
 
-const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
+const NavbarItemPosition = _utilsValidation.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(),
-})
-  // We allow any unknown attributes on the links
-  // (users may need additional attributes like target, aria-role, data-customAttribute...)
-  .unknown();
+const NavbarItemBaseSchema = _utilsValidation.Joi.object({
+  label: _utilsValidation.Joi.string(),
+  html: _utilsValidation.Joi.string(),
+  className: _utilsValidation.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();
 
-// 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(),
+const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
+  to: _utilsValidation.Joi.string(),
+  href: _utilsValidation.URISchema,
+  activeBasePath: _utilsValidation.Joi.string(),
+  activeBaseRegex: _utilsValidation.Joi.string(),
+  prependBaseUrlToHref: _utilsValidation.Joi.bool(),
+  // This is only triggered in case of a nested dropdown
+  items: _utilsValidation.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'
 });
-// 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(),
+const DocsVersionNavbarItemSchema = NavbarItemBaseSchema.append({
+  type: _utilsValidation.Joi.string().equal('docsVersion').required(),
+  to: _utilsValidation.Joi.string(),
+  docsPluginId: _utilsValidation.Joi.string()
 });
-
-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 DocItemSchema = NavbarItemBaseSchema.append({
+  type: _utilsValidation.Joi.string().equal('doc').required(),
+  docId: _utilsValidation.Joi.string().required(),
+  docsPluginId: _utilsValidation.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 DocSidebarItemSchema = NavbarItemBaseSchema.append({
+  type: _utilsValidation.Joi.string().equal('docSidebar').required(),
+  sidebarId: _utilsValidation.Joi.string().required(),
+  docsPluginId: _utilsValidation.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 HtmlNavbarItemSchema = _utilsValidation.Joi.object({
+  className: _utilsValidation.Joi.string(),
+  type: _utilsValidation.Joi.string().equal('html').required(),
+  value: _utilsValidation.Joi.string().required()
+}); // A temporary workaround to allow users to add custom navbar items
+// See https://github.com/facebook/docusaurus/issues/7227
 
-const SearchItemSchema = Joi.object({
-  type: Joi.string().equal('search').required(),
-  position: NavbarItemPosition,
-});
 
-// 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();
+const CustomNavbarItemRegexp = /custom-.*/;
+
+const CustomNavbarItemSchema = _utilsValidation.Joi.object({
+  type: _utilsValidation.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 ? _utilsValidation.Joi.string().required().regex(type) : type ? _utilsValidation.Joi.string().required().equal(type) : _utilsValidation.Joi.string().forbidden();
+  return _utilsValidation.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({
-        'any.unknown': 'Bad navbar item type {.type}',
-      }),
-    },
-  ],
-  otherwise: DefaultNavbarItemSchema,
+const DropdownSubitemSchema = _utilsValidation.Joi.object({
+  position: _utilsValidation.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: _utilsValidation.Joi.alternatives().try(itemWithType('dropdown'), itemWithType('docsVersionDropdown'), itemWithType('localeDropdown'), itemWithType('search')),
+    then: _utilsValidation.Joi.forbidden().messages({
+      'any.unknown': 'Nested dropdowns are not allowed'
+    })
+  }],
+  otherwise: _utilsValidation.Joi.forbidden().messages({
+    'any.unknown': 'Bad navbar item type {.type}'
+  })
 });
 
-/*
-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 DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+  items: _utilsValidation.Joi.array().items(DropdownSubitemSchema).required()
+});
+const DocsVersionDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+  type: _utilsValidation.Joi.string().equal('docsVersionDropdown').required(),
+  docsPluginId: _utilsValidation.Joi.string(),
+  dropdownActiveClassDisabled: _utilsValidation.Joi.boolean(),
+  dropdownItemsBefore: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([]),
+  dropdownItemsAfter: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([])
+});
+const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+  type: _utilsValidation.Joi.string().equal('localeDropdown').required(),
+  dropdownItemsBefore: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([]),
+  dropdownItemsAfter: _utilsValidation.Joi.array().items(DropdownSubitemSchema).default([])
+});
 
- */
+const SearchItemSchema = _utilsValidation.Joi.object({
+  type: _utilsValidation.Joi.string().equal('search').required()
+});
 
-/*
-const NavbarItemSchema = Joi.object().when('type', {
-  is: Joi.valid('docsVersion'),
-  then: DocsVersionNavbarItemSchema,
-  otherwise: DefaultNavbarItemSchema,
+const NavbarItemSchema = _utilsValidation.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: _utilsValidation.Joi.object().when('.', {
+      // Dropdown item can be specified without type field
+      is: _utilsValidation.Joi.object({
+        items: _utilsValidation.Joi.array().required()
+      }).unknown(),
+      then: DropdownNavbarItemSchema,
+      otherwise: DefaultNavbarItemSchema
+    })
+  }],
+  otherwise: _utilsValidation.Joi.forbidden().messages({
+    'any.unknown': 'Bad navbar item type {.type}'
+  })
 });
- */
 
-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 ColorModeSchema = _utilsValidation.Joi.object({
+  defaultMode: _utilsValidation.Joi.string().equal('dark', 'light').default(DEFAULT_COLOR_MODE_CONFIG.defaultMode),
+  disableSwitch: _utilsValidation.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.disableSwitch),
+  respectPrefersColorScheme: _utilsValidation.Joi.bool().default(DEFAULT_COLOR_MODE_CONFIG.respectPrefersColorScheme),
+  switchConfig: _utilsValidation.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 = _utilsValidation.Joi.object({
+  id: _utilsValidation.Joi.string(),
+  name: _utilsValidation.Joi.string(),
+  property: _utilsValidation.Joi.string(),
+  content: _utilsValidation.Joi.string(),
+  itemprop: _utilsValidation.Joi.string()
 }).unknown();
 
-const FooterLinkItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
-  html: Joi.string(),
-  label: 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 FooterLinkItemSchema = _utilsValidation.Joi.object({
+  to: _utilsValidation.Joi.string(),
+  href: _utilsValidation.URISchema,
+  html: _utilsValidation.Joi.string(),
+  label: _utilsValidation.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 CustomCssSchema = _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array().items(_utilsValidation.Joi.string().required()), _utilsValidation.Joi.string().required()).optional();
 
-const ThemeConfigSchema = Joi.object({
+const ThemeConfigSchema = _utilsValidation.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',
+  disableDarkMode: _utilsValidation.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'
   }),
   // 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"',
+  defaultDarkMode: _utilsValidation.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"'
   }),
   customCss: CustomCssSchema,
   colorMode: ColorModeSchema,
-  image: Joi.string(),
+  image: _utilsValidation.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),
+  metadata: _utilsValidation.Joi.array().items(HtmlMetadataSchema).default(DEFAULT_CONFIG.metadata),
+  // cSpell:ignore metadatas
+  metadatas: _utilsValidation.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'
+  }),
+  announcementBar: _utilsValidation.Joi.object({
+    id: _utilsValidation.Joi.string().default('announcement-bar'),
+    content: _utilsValidation.Joi.string().required(),
+    backgroundColor: _utilsValidation.Joi.string(),
+    textColor: _utilsValidation.Joi.string(),
+    isCloseable: _utilsValidation.Joi.bool().default(true)
   }).optional(),
-  navbar: Joi.object({
-    style: Joi.string().equal('dark', 'primary'),
-    hideOnScroll: Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
+  navbar: _utilsValidation.Joi.object({
+    style: _utilsValidation.Joi.string().equal('dark', 'primary'),
+    hideOnScroll: _utilsValidation.Joi.bool().default(DEFAULT_CONFIG.navbar.hideOnScroll),
     // TODO temporary (@alpha-58)
-    links: Joi.any().forbidden().messages({
-      'any.unknown':
-        'themeConfig.navbar.links has been renamed as themeConfig.navbar.items',
-    }),
-    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(),
+    links: _utilsValidation.Joi.any().forbidden().messages({
+      'any.unknown': 'themeConfig.navbar.links has been renamed as themeConfig.navbar.items'
     }),
+    items: _utilsValidation.Joi.array().items(NavbarItemSchema).default(DEFAULT_CONFIG.navbar.items),
+    title: _utilsValidation.Joi.string().allow('', null),
+    logo: _utilsValidation.Joi.object({
+      alt: _utilsValidation.Joi.string().allow(''),
+      src: _utilsValidation.Joi.string().required(),
+      srcDark: _utilsValidation.Joi.string(),
+      width: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
+      height: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
+      href: _utilsValidation.Joi.string(),
+      target: _utilsValidation.Joi.string()
+    })
   }).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(),
+  footer: _utilsValidation.Joi.object({
+    style: _utilsValidation.Joi.string().equal('dark', 'light').default('light'),
+    logo: _utilsValidation.Joi.object({
+      alt: _utilsValidation.Joi.string().allow(''),
+      src: _utilsValidation.Joi.string().required(),
+      srcDark: _utilsValidation.Joi.string(),
+      // TODO infer this from reading the image
+      width: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
+      height: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.string(), _utilsValidation.Joi.number()),
+      href: _utilsValidation.Joi.string()
     }),
-    copyright: Joi.string(),
-    links: Joi.array()
-      .items(
-        Joi.object({
-          title: Joi.string().allow(null),
-          items: Joi.array().items(FooterLinkItemSchema).default([]),
-        }),
-      )
-      .default([]),
+    copyright: _utilsValidation.Joi.string(),
+    links: _utilsValidation.Joi.alternatives(_utilsValidation.Joi.array().items(_utilsValidation.Joi.object({
+      title: _utilsValidation.Joi.string().allow(null).default(null),
+      items: _utilsValidation.Joi.array().items(FooterLinkItemSchema).default([])
+    })), _utilsValidation.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: Joi.object({
-    theme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
+  prism: _utilsValidation.Joi.object({
+    theme: _utilsValidation.Joi.object({
+      plain: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required(),
+      styles: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required()
+    }).default(DEFAULT_CONFIG.prism.theme),
+    darkTheme: _utilsValidation.Joi.object({
+      plain: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required(),
+      styles: _utilsValidation.Joi.alternatives().try(_utilsValidation.Joi.array(), _utilsValidation.Joi.object()).required()
     }),
-    darkTheme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
+    defaultLanguage: _utilsValidation.Joi.string(),
+    additionalLanguages: _utilsValidation.Joi.array().items(_utilsValidation.Joi.string()).default(DEFAULT_CONFIG.prism.additionalLanguages),
+    magicComments: _utilsValidation.Joi.array().items(_utilsValidation.Joi.object({
+      className: _utilsValidation.Joi.string().required(),
+      line: _utilsValidation.Joi.string(),
+      block: _utilsValidation.Joi.object({
+        start: _utilsValidation.Joi.string().required(),
+        end: _utilsValidation.Joi.string().required()
+      })
+    }).or('line', 'block')).default(DEFAULT_CONFIG.prism.magicComments)
+  }).default(DEFAULT_CONFIG.prism).unknown(),
+  hideableSidebar: _utilsValidation.Joi.forbidden().messages({
+    'any.unknown': 'themeConfig.hideableSidebar has been moved to themeConfig.docs.sidebar.hideable.'
+  }),
+  autoCollapseSidebarCategories: _utilsValidation.Joi.forbidden().messages({
+    'any.unknown': 'themeConfig.autoCollapseSidebarCategories has been moved to themeConfig.docs.sidebar.autoCollapseCategories.'
+  }),
+  sidebarCollapsible: _utilsValidation.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'
+  }),
+  tableOfContents: _utilsValidation.Joi.object({
+    minHeadingLevel: _utilsValidation.Joi.number().default(DEFAULT_CONFIG.tableOfContents.minHeadingLevel).when('maxHeadingLevel', {
+      is: _utilsValidation.Joi.exist(),
+      then: _utilsValidation.Joi.number().integer().min(2).max(6).max(_utilsValidation.Joi.ref('maxHeadingLevel')),
+      otherwise: _utilsValidation.Joi.number().integer().min(2).max(6)
     }),
-    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),
+    maxHeadingLevel: _utilsValidation.Joi.number().integer().min(2).max(6).default(DEFAULT_CONFIG.tableOfContents.maxHeadingLevel)
+  }).default(DEFAULT_CONFIG.tableOfContents)
 });
+
 exports.ThemeConfigSchema = ThemeConfigSchema;
 
-exports.validateThemeConfig = ({validate, themeConfig}) => {
+function validateThemeConfig({
+  validate,
+  themeConfig
+}) {
   return validate(ThemeConfigSchema, themeConfig);
-};
+}