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

package/lib/options.js

@@ -0,0 +1,409 @@
+"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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateOptions = 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',
+    sidebar: {
+        hideable: false,
+        autoCollapseCategories: false,
+    },
+};
+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,
+};
+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,
+    },
+};
+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(),
+})
+    .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 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 = 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 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 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(),
+});
+// 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 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}',
+    }),
+});
+const DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+    items: utils_validation_1.Joi.array().items(DropdownSubitemSchema).required(),
+});
+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);
+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 = 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 LogoSchema = 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(),
+    style: utils_validation_1.Joi.object(),
+    className: utils_validation_1.Joi.string(),
+});
+exports.ThemeConfigSchema = utils_validation_1.Joi.object({
+    // TODO temporary (@alpha-58)
+    // @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',
+    }),
+    // 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"',
+    }),
+    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',
+    }),
+    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: LogoSchema,
+    }).default(exports.DEFAULT_CONFIG.navbar),
+    footer: utils_validation_1.Joi.object({
+        style: utils_validation_1.Joi.string().equal('dark', 'light').default('light'),
+        logo: LogoSchema,
+        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.',
+    }),
+    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',
+    }),
+    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),
+});
+function validateThemeConfig({ validate, themeConfig, }) {
+    return validate(exports.ThemeConfigSchema, themeConfig);
+}
+exports.validateThemeConfig = validateThemeConfig;
+const DEFAULT_OPTIONS = {
+    customCss: [],
+};
+const PluginOptionSchema = utils_validation_1.Joi.object({
+    customCss: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().required()), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().required(), {
+        then: utils_validation_1.Joi.custom((val) => [val]),
+        otherwise: utils_validation_1.Joi.forbidden().messages({
+            'any.unknown': '"customCss" must be a string or an array of strings',
+        }),
+    }))
+        .default(DEFAULT_OPTIONS.customCss),
+});
+function validateOptions({ validate, options, }) {
+    const validatedOptions = validate(PluginOptionSchema, options);
+    return validatedOptions;
+}
+exports.validateOptions = validateOptions;

package/lib/prism-include-languages.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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.
+ */
+export {};

package/lib/prism-include-languages.js

@@ -4,8 +4,6 @@
  * 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/lib/theme/Admonition/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/Admonition';
+export default function Admonition(props: Props): JSX.Element;

package/lib/theme/Admonition/index.js

@@ -0,0 +1,183 @@
+/**
+ * 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';
+import {ThemeClassNames} from '@docusaurus/theme-common';
+import Translate from '@docusaurus/Translate';
+import styles from './styles.module.css';
+function NoteIcon() {
+  return (
+    <svg 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>
+  );
+}
+function TipIcon() {
+  return (
+    <svg 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>
+  );
+}
+function DangerIcon() {
+  return (
+    <svg 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>
+  );
+}
+function InfoIcon() {
+  return (
+    <svg 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>
+  );
+}
+function CautionIcon() {
+  return (
+    <svg 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>
+  );
+}
+// eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
+const AdmonitionConfigs = {
+  note: {
+    infimaClassName: 'secondary',
+    iconComponent: NoteIcon,
+    label: (
+      <Translate
+        id="theme.admonition.note"
+        description="The default label used for the Note admonition (:::note)">
+        note
+      </Translate>
+    ),
+  },
+  tip: {
+    infimaClassName: 'success',
+    iconComponent: TipIcon,
+    label: (
+      <Translate
+        id="theme.admonition.tip"
+        description="The default label used for the Tip admonition (:::tip)">
+        tip
+      </Translate>
+    ),
+  },
+  danger: {
+    infimaClassName: 'danger',
+    iconComponent: DangerIcon,
+    label: (
+      <Translate
+        id="theme.admonition.danger"
+        description="The default label used for the Danger admonition (:::danger)">
+        danger
+      </Translate>
+    ),
+  },
+  info: {
+    infimaClassName: 'info',
+    iconComponent: InfoIcon,
+    label: (
+      <Translate
+        id="theme.admonition.info"
+        description="The default label used for the Info admonition (:::info)">
+        info
+      </Translate>
+    ),
+  },
+  caution: {
+    infimaClassName: 'warning',
+    iconComponent: CautionIcon,
+    label: (
+      <Translate
+        id="theme.admonition.caution"
+        description="The default label used for the Caution admonition (:::caution)">
+        caution
+      </Translate>
+    ),
+  },
+};
+// Legacy aliases, undocumented but kept for retro-compatibility
+const aliases = {
+  secondary: 'note',
+  important: 'info',
+  success: 'tip',
+  warning: 'danger',
+};
+function getAdmonitionConfig(unsafeType) {
+  const type = aliases[unsafeType] ?? unsafeType;
+  const config = AdmonitionConfigs[type];
+  if (config) {
+    return config;
+  }
+  console.warn(
+    `No admonition config found for admonition type "${type}". Using Info as fallback.`,
+  );
+  return AdmonitionConfigs.info;
+}
+// Workaround because it's difficult in MDX v1 to provide a MDX title as props
+// See https://github.com/facebook/docusaurus/pull/7152#issuecomment-1145779682
+function extractMDXAdmonitionTitle(children) {
+  const items = React.Children.toArray(children);
+  const mdxAdmonitionTitle = items.find(
+    (item) =>
+      React.isValidElement(item) &&
+      item.props?.mdxType === 'mdxAdmonitionTitle',
+  );
+  const rest = <>{items.filter((item) => item !== mdxAdmonitionTitle)}</>;
+  return {
+    mdxAdmonitionTitle,
+    rest,
+  };
+}
+function processAdmonitionProps(props) {
+  const {mdxAdmonitionTitle, rest} = extractMDXAdmonitionTitle(props.children);
+  return {
+    ...props,
+    title: props.title ?? mdxAdmonitionTitle,
+    children: rest,
+  };
+}
+export default function Admonition(props) {
+  const {children, type, title, icon: iconProp} = processAdmonitionProps(props);
+  const typeConfig = getAdmonitionConfig(type);
+  const titleLabel = title ?? typeConfig.label;
+  const {iconComponent: IconComponent} = typeConfig;
+  const icon = iconProp ?? <IconComponent />;
+  return (
+    <div
+      className={clsx(
+        ThemeClassNames.common.admonition,
+        ThemeClassNames.common.admonitionType(props.type),
+        'alert',
+        `alert--${typeConfig.infimaClassName}`,
+        styles.admonition,
+      )}>
+      <div className={styles.admonitionHeading}>
+        <span className={styles.admonitionIcon}>{icon}</span>
+        {titleLabel}
+      </div>
+      <div className={styles.admonitionContent}>{children}</div>
+    </div>
+  );
+}

package/lib/{admonitions.css → theme/Admonition/styles.module.css}

@@ -5,31 +5,34 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-.admonition h5 {
-  margin-top: 0;
-  margin-bottom: 8px;
+.admonition {
+  margin-bottom: 1em;
+}
+
+.admonitionHeading {
+  font: var(--ifm-heading-font-weight) var(--ifm-h5-font-size) /
+    var(--ifm-heading-line-height) var(--ifm-heading-font-family);
   text-transform: uppercase;
+  margin-bottom: 0.3rem;
+}
+
+.admonitionHeading code {
+  text-transform: none;
 }
 
-.admonition-icon {
+.admonitionIcon {
   display: inline-block;
   vertical-align: middle;
   margin-right: 0.4em;
 }
 
-.admonition-icon svg {
+.admonitionIcon svg {
   display: inline-block;
-  width: 22px;
-  height: 22px;
-  stroke-width: 0;
+  height: 1.6em;
+  width: 1.6em;
   fill: var(--ifm-alert-foreground-color);
-  stroke: var(--ifm-alert-foreground-color);
 }
 
-.admonition-content > :last-child {
+.admonitionContent > :last-child {
   margin-bottom: 0;
 }
-
-.admonition {
-  margin-bottom: 1em;
-}

package/lib/theme/AnnouncementBar/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+export default function AnnouncementBar(): JSX.Element | null;