mirrors
/
mermaid
mirror of https://github.com/mermaid-js/mermaid.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

chore: Update docs to remove html tag like text

This commit is contained in:
Sidharth Vinod 2024-06-21 08:45:52 +05:30
parent 77a02fefe4
commit 5ba3696f95
No known key found for this signature in database
GPG Key ID: FB5CCD378D3907CD
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/config/setup/modules/mermaidAPI.md
View File

@ -34,7 +34,7 @@ Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
• `Const` **mermaidAPI**: `Readonly`<{ `defaultConfig`: `MermaidConfig` = configApi.defaultConfig; `getConfig`: () => `MermaidConfig` = configApi.getConfig; `getDiagramFromText`: (`text`: `string`, `metadata`: `Pick`<`DiagramMetadata`, `"title"`>) => `Promise`<`Diagram`> ; `getSiteConfig`: () => `MermaidConfig` = configApi.getSiteConfig; `globalReset`: () => `void` ; `initialize`: (`options`: `MermaidConfig`) => `void` ; `parse`: (`text`: `string`, `parseOptions`: [`ParseOptions`](../interfaces/mermaidAPI.ParseOptions.md) & { `suppressErrors`: `true` }) => `Promise`<[`ParseResult`](../interfaces/mermaidAPI.ParseResult.md) | `false`>(`text`: `string`, `parseOptions?`: [`ParseOptions`](../interfaces/mermaidAPI.ParseOptions.md)) => `Promise`<[`ParseResult`](../interfaces/mermaidAPI.ParseResult.md)> ; `render`: (`id`: `string`, `text`: `string`, `svgContainingElement?`: `Element`) => `Promise`<[`RenderResult`](../interfaces/mermaidAPI.RenderResult.md)> ; `reset`: () => `void` ; `setConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.setConfig; `updateSiteConfig`: (`conf`: `MermaidConfig`) => `MermaidConfig` = configApi.updateSiteConfig }>
- Use mermaid.<function> instead of mermaid.mermaidAPI.<function>
- Use mermaid.function instead of mermaid.mermaidAPI.function
#### Defined in

2
packages/mermaid/src/mermaidAPI.ts
View File

@ -568,7 +568,7 @@ function addA11yInfo(
}
/**
* @internal - Use mermaid.<function> instead of mermaid.mermaidAPI.<function>
* @internal - Use mermaid.function instead of mermaid.mermaidAPI.function
*/
export const mermaidAPI = Object.freeze({
render,