marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-08-30 13:46:43 +02:00
Code Issues Packages Projects Releases Wiki Activity

Grammatical touch-ups

Browse Source
This commit is contained in:
Lorin Thwaits
2022-08-19 17:55:50 +01:00
parent a89b6fd054
commit 6635d4bc97
23 changed files with 273 additions and 290 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/developer-docs/configuration.md
View File

@@ -1,10 +1,10 @@
# Configuration
When mermaid starts configuration is extracted to a configuration to be used for a diagram. There are 3 sources for configuration:
When mermaid starts, configuration is extracted to determine a configuration to be used for a diagram. There are 3 sources for configuration:
* The default configuration
* Overrides on the site level is set by the initialize call and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**.
* Directives - diagram authors can update select configuration parameters directly in the diagram code via directives and these are applied to the render config.
* Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**.
* Directives - diagram authors can update select configuration parameters directly in the diagram code via directives. These are applied to the render config.
**The render config** is configuration that is used when rendering by applying these configurations.
@@ -21,8 +21,8 @@ sequenceDiagram
## Initialize
Initialize call is called **only once**. It is called by the site integrator in order to override the default configuration on a site level.
The initialize call is applied **only once**. It is called by the site integrator in order to override the default configuration at a site level.
## configApi.reset
This method resets the configuration for a diagram to the site configuration, the configuration provided by the site integrator. Before each rendering of a diagram reset is called in the very beginning of render.
This method resets the configuration for a diagram to the overall site configuration, which is the configuration provided by the site integrator. Before each rendering of a diagram, reset is called at the very beginning.