@docusaurus/types 0.0.0-5332 → 0.0.0-5335

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "0.0.0-5332",
+  "version": "0.0.0-5335",
   "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": "87c793e511060b3753659e150782f38b25694aec"
+  "gitHead": "42c59e0828b093f765f6c37d522c02ef74846a31"
 }

package/src/config.d.ts

@@ -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.
  */
@@ -277,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';