@docusaurus/types 3.10.1-canary-6655 → 3.10.1-canary-6803

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "3.10.1-canary-6655",
+  "version": "3.10.1-canary-6803",
   "description": "Common types for Docusaurus packages.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -28,5 +28,5 @@
     "react": "^19.2.0",
     "react-dom": "^19.2.0"
   },
-  "gitHead": "6e93a3055178dd0af922ba627f787229dcdf948b"
+  "gitHead": "d2c7b381512bd4e7e90e33f56649e68d618eaa92"
 }

package/src/index.d.ts

@@ -28,6 +28,7 @@ export {
   ParseFrontMatter,
   OnBrokenMarkdownLinksFunction,
   OnBrokenMarkdownImagesFunction,
+  OnUnusedMarkdownDirectivesFunction,
 } from './markdown';
 
 export {ReportingSeverity} from './reporting';

package/src/markdown.d.ts

@@ -7,6 +7,7 @@
 
 import type {ProcessorOptions} from '@mdx-js/mdx';
 import type {Image, Definition, Link} from 'mdast';
+import type {Directives} from 'mdast-util-directive';
 
 import type {ReportingSeverity} from './reporting';
 
@@ -86,6 +87,21 @@ export type OnBrokenMarkdownImagesFunction = (params: {
   node: Image;
 }) => void | string;
 
+export type OnUnusedMarkdownDirectivesFunction = (params: {
+  /**
+   * Path of the source file on which the unused directive was found
+   * Relative to the site dir.
+   * Example: "docs/category/myDoc.mdx"
+   */
+  sourceFilePath: string;
+
+  /**
+   * The Markdown directives that were unused.
+   * Example: "myDirective"
+   */
+  directives: Directives[];
+}) => void | string;
+
 export type MarkdownHooks = {
   /**
    * The behavior of Docusaurus when it detects any broken Markdown link.
@@ -97,6 +113,10 @@ export type MarkdownHooks = {
   onBrokenMarkdownLinks: ReportingSeverity | OnBrokenMarkdownLinksFunction;
 
   onBrokenMarkdownImages: ReportingSeverity | OnBrokenMarkdownImagesFunction;
+
+  onUnusedMarkdownDirectives:
+    | ReportingSeverity
+    | OnUnusedMarkdownDirectivesFunction;
 };
 
 export type MarkdownConfig = {