diff --git a/packages/mermaid/src/diagram-api/diagramAPI.ts b/packages/mermaid/src/diagram-api/diagramAPI.ts index 4b21e7d8e..2727ae4ef 100644 --- a/packages/mermaid/src/diagram-api/diagramAPI.ts +++ b/packages/mermaid/src/diagram-api/diagramAPI.ts @@ -27,24 +27,9 @@ export interface Detectors { * * Can be used for third-party custom diagrams. * - * For third-party diagrams that are rarely used, we recommend instead setting - * the `lazyLoadedDiagrams` param in the Mermaid config, as that will instead - * only load the diagram when needed. - * * @param id - A unique ID for the given diagram. * @param diagram - The diagram definition. * @param detector - Function that returns `true` if a given mermaid text is this diagram definition. - * - * @example How to add `@mermaid-js/mermaid-mindmap` to mermaid - * - * ```js - * import { - * diagram as mindmap, detector as mindmapDetector, id as mindmapId - * } from "@mermaid-js/mermaid-mindmap"; - * import mermaid from "mermaid"; - * - * mermaid.mermaidAPI.registerDiagram(mindmapId, mindmap, mindmapDetector); - * ``` */ export const registerDiagram = ( id: string,