Files
mermaid/docs/Configuration.md
Alois Klink 70f94c3e44 chore(docs): run pnpm run docs:build
Updates the auto-generated warning to tell people
to edit packages/mermaid/src/docs instead of src/docs.
2022-09-29 20:02:16 +01:00

1.3 KiB

THIS IS AN AUTOGENERATED FILE. DO NOT EDIT. Please edit the corresponding file in packages/mermaid/src/docs.

Configuration

Configuration is the second half of Mermaid, after deployment. Together Deployment and Configuration constitute the whole of Mermaid.

This section will introduce the different methods of configuring of the behaviors and appearances of Mermaid Diagrams. The Following are the most commonly used methods, and are all tied to Mermaid Deployment methods.

Configuration Section in the Live Editor.

The initialize() call, for when Mermaid is called via an API, or through a <script> tag.

Directives,

Directives allows limited reconfiguration of a diagram just before it is rendered. It can alter the font style, color and other aesthetic aspects of the diagram. You can pass a directive alongside your definition inside %%{ }%%, either above or below your diagram definition.

Theme Creation:

An application of using Directives to change Themes. Theme is an value within mermaid's configuration that dictates the color scheme for diagrams.

If you are interested in altering and customizing your Mermaid Diagrams, you will find the methods and values available for Configuration here. It includes themes