@docusaurus/types 2.1.0 → 2.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Common types for Docusaurus packages.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -26,5 +26,5 @@
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
-  "gitHead": "be9b0942641184213485eba7fd75ceb0b328d3f4"
+  "gitHead": "a308fb7c81832cca354192fe2984f52749441249"
 }

package/src/config.d.ts

@@ -8,7 +8,7 @@
 import type {RuleSetRule} from 'webpack';
 import type {Required as RequireKeys, DeepPartial} from 'utility-types';
 import type {I18nConfig} from './i18n';
-import type {PluginConfig, PresetConfig} from './plugin';
+import type {PluginConfig, PresetConfig, HtmlTagObject} from './plugin';
 
 export type ReportingSeverity = 'ignore' | 'log' | 'warn' | 'throw';
 
@@ -16,6 +16,20 @@ export type ThemeConfig = {
   [key: string]: unknown;
 };
 
+export type MarkdownConfig = {
+  /**
+   * Allow mermaid language code blocks to be rendered into Mermaid diagrams:
+   *
+   * - `true`: code blocks with language mermaid will be rendered.
+   * - `false` | `undefined` (default): code blocks with language mermaid
+   * will be left as code blocks.
+   *
+   * @see https://docusaurus.io/docs/markdown-features/diagrams/
+   * @default false
+   */
+  mermaid?: boolean;
+};
+
 /**
  * Docusaurus config, after validation/normalization.
  */
@@ -192,6 +206,13 @@ export type DocusaurusConfig = {
    * @default ["static"]
    */
   staticDirectories: string[];
+  /**
+   * An array of tags that will be inserted in the HTML `<head>`.
+   *
+   * @see https://docusaurus.io/docs/api/docusaurus-config#head
+   * @default []
+   */
+  headTags: HtmlTagObject[];
   /**
    * An array of scripts to load. The values can be either strings or plain
    * objects of attribute-value maps. The `<script>` tags will be inserted in
@@ -270,6 +291,8 @@ export type DocusaurusConfig = {
      */
     jsLoader: 'babel' | ((isServer: boolean) => RuleSetRule);
   };
+  /** Markdown-related options. */
+  markdown: MarkdownConfig;
 };
 
 /**

package/src/index.d.ts

@@ -8,6 +8,7 @@
 export {
   ReportingSeverity,
   ThemeConfig,
+  MarkdownConfig,
   DocusaurusConfig,
   Config,
 } from './config';