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

package/lib/validateThemeConfig.js

@@ -1,317 +1,309 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ThemeConfigSchema = exports.DEFAULT_CONFIG = void 0;
+exports.validateThemeConfig = validateThemeConfig;
+
+var _utilsValidation = require("@docusaurus/utils-validation");
+
 /**
  * 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',
+  versionPersistence: 'localStorage'
 };
-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)
 }).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: [],
+    additionalLanguages: []
   },
   navbar: {
     hideOnScroll: false,
-    items: [],
+    items: []
   },
   hideableSidebar: false,
+  autoCollapseSidebarCategories: 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.string(),
-})
-  // 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(),
+  className: _utilsValidation.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(),
+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 DocSidebarItemSchema = NavbarItemBaseSchema.append({
+  type: _utilsValidation.Joi.string().equal('docSidebar').required(),
+  sidebarId: _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 itemWithType = type => {
+  // because equal(undefined) is not supported :/
+  const typeSchema = type ? _utilsValidation.Joi.string().required().equal(type) : _utilsValidation.Joi.string().forbidden();
+  return _utilsValidation.Joi.object({
+    type: typeSchema
+  }).unknown().required();
+};
+
+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: _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 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 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 = Joi.object({
-  type: Joi.string().equal('search').required(),
-  position: NavbarItemPosition,
+const SearchItemSchema = _utilsValidation.Joi.object({
+  type: _utilsValidation.Joi.string().equal('search').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,
+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(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}'
   })
-    .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 NavbarItemSchema = Joi.object({
-  type: Joi.string().only(['docsVersion'])
-})
-  .when(Joi.object({ type: 'docsVersion' }).unknown(), {
-    then: Joi.object({ pepperoni: Joi.boolean() })
+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.'
   })
-  .when(Joi.object().unknown(), {
-    then: Joi.object({ croutons: Joi.boolean() })
-  })
-
- */
-
-/*
-const NavbarItemSchema = Joi.object().when('type', {
-  is: Joi.valid('docsVersion'),
-  then: DocsVersionNavbarItemSchema,
-  otherwise: DefaultNavbarItemSchema,
-});
- */
+}).default(DEFAULT_COLOR_MODE_CONFIG); // schema can probably be improved
 
-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),
-}).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().default('#fff'),
-    textColor: Joi.string().default('#000'),
-    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()
     }),
-    darkTheme: Joi.object({
-      plain: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
-      styles: Joi.alternatives().try(Joi.array(), Joi.object()).required(),
+    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()
     }),
-    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),
+    defaultLanguage: _utilsValidation.Joi.string(),
+    additionalLanguages: _utilsValidation.Joi.array().items(_utilsValidation.Joi.string()).default(DEFAULT_CONFIG.prism.additionalLanguages)
+  }).default(DEFAULT_CONFIG.prism).unknown(),
+  hideableSidebar: _utilsValidation.Joi.bool().default(DEFAULT_CONFIG.hideableSidebar),
+  autoCollapseSidebarCategories: _utilsValidation.Joi.bool().default(DEFAULT_CONFIG.autoCollapseSidebarCategories),
+  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)
+    }),
+    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);
-};
+}

package/lib-next/theme/Admonition/index.js

@@ -0,0 +1,101 @@
+/**
+ * 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 React from 'react';
+import clsx from 'clsx';
+const icons = {
+  note: (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      width="14"
+      height="16"
+      viewBox="0 0 14 16">
+      <path
+        fillRule="evenodd"
+        d="M6.3 5.69a.942.942 0 0 1-.28-.7c0-.28.09-.52.28-.7.19-.18.42-.28.7-.28.28 0 .52.09.7.28.18.19.28.42.28.7 0 .28-.09.52-.28.7a1 1 0 0 1-.7.3c-.28 0-.52-.11-.7-.3zM8 7.99c-.02-.25-.11-.48-.31-.69-.2-.19-.42-.3-.69-.31H6c-.27.02-.48.13-.69.31-.2.2-.3.44-.31.69h1v3c.02.27.11.5.31.69.2.2.42.31.69.31h1c.27 0 .48-.11.69-.31.2-.19.3-.42.31-.69H8V7.98v.01zM7 2.3c-3.14 0-5.7 2.54-5.7 5.68 0 3.14 2.56 5.7 5.7 5.7s5.7-2.55 5.7-5.7c0-3.15-2.56-5.69-5.7-5.69v.01zM7 .98c3.86 0 7 3.14 7 7s-3.14 7-7 7-7-3.12-7-7 3.14-7 7-7z"
+      />
+    </svg>
+  ),
+  tip: (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      width="12"
+      height="16"
+      viewBox="0 0 12 16">
+      <path
+        fillRule="evenodd"
+        d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"
+      />
+    </svg>
+  ),
+  danger: (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      width="12"
+      height="16"
+      viewBox="0 0 12 16">
+      <path
+        fillRule="evenodd"
+        d="M5.05.31c.81 2.17.41 3.38-.52 4.31C3.55 5.67 1.98 6.45.9 7.98c-1.45 2.05-1.7 6.53 3.53 7.7-2.2-1.16-2.67-4.52-.3-6.61-.61 2.03.53 3.33 1.94 2.86 1.39-.47 2.3.53 2.27 1.67-.02.78-.31 1.44-1.13 1.81 3.42-.59 4.78-3.42 4.78-5.56 0-2.84-2.53-3.22-1.25-5.61-1.52.13-2.03 1.13-1.89 2.75.09 1.08-1.02 1.8-1.86 1.33-.67-.41-.66-1.19-.06-1.78C8.18 5.31 8.68 2.45 5.05.32L5.03.3l.02.01z"
+      />
+    </svg>
+  ),
+  info: (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      width="14"
+      height="16"
+      viewBox="0 0 14 16">
+      <path
+        fillRule="evenodd"
+        d="M7 2.3c3.14 0 5.7 2.56 5.7 5.7s-2.56 5.7-5.7 5.7A5.71 5.71 0 0 1 1.3 8c0-3.14 2.56-5.7 5.7-5.7zM7 1C3.14 1 0 4.14 0 8s3.14 7 7 7 7-3.14 7-7-3.14-7-7-7zm1 3H6v5h2V4zm0 6H6v2h2v-2z"
+      />
+    </svg>
+  ),
+  caution: (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      width="16"
+      height="16"
+      viewBox="0 0 16 16">
+      <path
+        fillRule="evenodd"
+        d="M8.893 1.5c-.183-.31-.52-.5-.887-.5s-.703.19-.886.5L.138 13.499a.98.98 0 0 0 0 1.001c.193.31.53.501.886.501h13.964c.367 0 .704-.19.877-.5a1.03 1.03 0 0 0 .01-1.002L8.893 1.5zm.133 11.497H6.987v-2.003h2.039v2.003zm0-3.004H6.987V5.987h2.039v4.006z"
+      />
+    </svg>
+  ),
+};
+const ifmClassNames = {
+  note: 'secondary',
+  tip: 'success',
+  danger: 'danger',
+  info: 'info',
+  caution: 'warning',
+};
+export default function Admonition({
+  children,
+  type,
+  title = type,
+  icon = icons[type],
+}) {
+  return (
+    <div
+      className={clsx(
+        'admonition',
+        `admonition-${type}`,
+        'alert',
+        `alert--${ifmClassNames[type]}`,
+      )}>
+      <div className="admonition-heading">
+        <h5>
+          <span className="admonition-icon">{icon}</span>
+          {title}
+        </h5>
+      </div>
+      <div className="admonition-content">{children}</div>
+    </div>
+  );
+}