marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-09-03 23:56:44 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update documents to compatible jekyll-rtd-theme

Browse Source
This commit is contained in:
saowang
2020-08-21 01:01:06 +08:00
parent f63b58edd9
commit 9e8c6aed4d
67 changed files with 435 additions and 295 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,30 +0,0 @@
# Configuration
When mermaid starts configuration is extracted to a configuration to be used for a diagram. There a 3 sources for configuration:
* The default configuration
* Overrides on the site level, set is set by the initialize call and will be applied for all diagrams in the site/app. The term for this is the **siteConfig**.
* Directives - diagram authors can update select configuration parameters directly int he diagram code via directives and these are applied to the render config.
**The render config** is configration that is used when rendering by applying these configurations.
## Theme configuration
## Starting mermaid
```mermaid
sequenceDiagram
Site->>mermaid: initialize
Site->>mermaid: content loaded
mermaid->>mermaidAPI: init
```
## Initialize
Intialize call is calloed **only once**. It is called by the site integrator in order to override the default configuration on 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.
##