marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-11 19:39:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
knsv
2024-03-06 10:14:35 +00:00
parent f5bd82461e
commit f0f1bec9ce
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/community/contributing.md
View File

@@ -372,7 +372,7 @@ Likewise, if users don't know that there is a new feature that you've implemente
The documentation has to be updated for users to know that things have been changed and added! The documentation has to be updated for users to know that things have been changed and added!
If you are adding a new feature, add `(v10.8.0+)` in the title or description. It will be replaced automatically with the current version number when the release happens. If you are adding a new feature, add `(v10.8.0+)` in the title or description. It will be replaced automatically with the current version number when the release happens.
eg: `# Feature Name (v10.8.0+)` eg: `# Feature Name (v10.8.0-b.2+)`
We know it can sometimes be hard to code _and_ write user documentation. We know it can sometimes be hard to code _and_ write user documentation.

8
docs/config/setup/interfaces/mermaidAPI.RenderResult.md
View File

@@ -14,6 +14,10 @@
• `Optional` **bindFunctions**: (`element`: `Element`) => `void` • `Optional` **bindFunctions**: (`element`: `Element`) => `void`
#### Type declaration
▸ (`element`): `void`
Bind function to be called after the svg has been inserted into the DOM. Bind function to be called after the svg has been inserted into the DOM.
This is necessary for adding event listeners to the elements in the svg. This is necessary for adding event listeners to the elements in the svg.
@@ -23,10 +27,6 @@ div.innerHTML = svg;
bindFunctions?.(div); // To call bindFunctions only if it's present. bindFunctions?.(div); // To call bindFunctions only if it's present.
``` ```
#### Type declaration
▸ (`element`): `void`
##### Parameters ##### Parameters
| Name | Type | | Name | Type |