marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-11-04 12:54:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix casing of Frontmatter config

Browse Source
This commit is contained in:
Sidharth Vinod
2025-04-18 13:28:41 +05:30
parent cb0cb5dfc7
commit 8a34154efa
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/config/theming.md
View File

@@ -8,7 +8,7 @@
Dynamic and integrated theme configuration was introduced in Mermaid version 8.7.0. Dynamic and integrated theme configuration was introduced in Mermaid version 8.7.0.
Themes can now be customized at the site-wide level, or on individual Mermaid diagrams. For site-wide theme customization, the `initialize` call is used. For diagram specific customization, Frontmatter config is used. Themes can now be customized at the site-wide level, or on individual Mermaid diagrams. For site-wide theme customization, the `initialize` call is used. For diagram specific customization, frontmatter config is used.
## Available Themes ## Available Themes
@@ -37,9 +37,9 @@ mermaid.initialize({
## Diagram-specific Themes ## Diagram-specific Themes
To customize the theme of an individual diagram, use Frontmatter config. To customize the theme of an individual diagram, use frontmatter config.
Example of Frontmatter config setting the `theme` to `forest`: Example of frontmatter config setting the `theme` to `forest`:
```mermaid-example ```mermaid-example
--- ---
@@ -63,15 +63,15 @@ config:
## Customizing Themes with `themeVariables` ## Customizing Themes with `themeVariables`
To make a custom theme, modify `themeVariables` via Frontmatter config. To make a custom theme, modify `themeVariables` via frontmatter config.
You will need to use the [base](#available-themes) theme as it is the only modifiable theme. You will need to use the [base](#available-themes) theme as it is the only modifiable theme.
| Parameter | Description | Type | Properties | | Parameter | Description | Type | Properties |
| -------------- | ---------------------------------- | ------ | ----------------------------------------------------------------------------------- | | -------------- | ---------------------------------- | ------ | ----------------------------------------------------------------------------------- |
| themeVariables | Modifiable with Frontmatter config | Object | `primaryColor`, `primaryTextColor`, `lineColor` ([see full list](#theme-variables)) | | themeVariables | Modifiable with frontmatter config | Object | `primaryColor`, `primaryTextColor`, `lineColor` ([see full list](#theme-variables)) |
Example of modifying `themeVariables` using Frontmatter config: Example of modifying `themeVariables` using frontmatter config:
```mermaid-example ```mermaid-example
--- ---

12
packages/mermaid/src/docs/config/theming.md
View File

@@ -2,7 +2,7 @@
Dynamic and integrated theme configuration was introduced in Mermaid version 8.7.0. Dynamic and integrated theme configuration was introduced in Mermaid version 8.7.0.
Themes can now be customized at the site-wide level, or on individual Mermaid diagrams. For site-wide theme customization, the `initialize` call is used. For diagram specific customization, Frontmatter config is used. Themes can now be customized at the site-wide level, or on individual Mermaid diagrams. For site-wide theme customization, the `initialize` call is used. For diagram specific customization, frontmatter config is used.
## Available Themes ## Available Themes
@@ -31,9 +31,9 @@ mermaid.initialize({
## Diagram-specific Themes ## Diagram-specific Themes
To customize the theme of an individual diagram, use Frontmatter config. To customize the theme of an individual diagram, use frontmatter config.
Example of Frontmatter config setting the `theme` to `forest`: Example of frontmatter config setting the `theme` to `forest`:
```mermaid-example ```mermaid-example
--- ---
@@ -48,15 +48,15 @@ config:
## Customizing Themes with `themeVariables` ## Customizing Themes with `themeVariables`
To make a custom theme, modify `themeVariables` via Frontmatter config. To make a custom theme, modify `themeVariables` via frontmatter config.
You will need to use the [base](#available-themes) theme as it is the only modifiable theme. You will need to use the [base](#available-themes) theme as it is the only modifiable theme.
| Parameter | Description | Type | Properties | | Parameter | Description | Type | Properties |
| -------------- | ---------------------------------- | ------ | ----------------------------------------------------------------------------------- | | -------------- | ---------------------------------- | ------ | ----------------------------------------------------------------------------------- |
| themeVariables | Modifiable with Frontmatter config | Object | `primaryColor`, `primaryTextColor`, `lineColor` ([see full list](#theme-variables)) | | themeVariables | Modifiable with frontmatter config | Object | `primaryColor`, `primaryTextColor`, `lineColor` ([see full list](#theme-variables)) |
Example of modifying `themeVariables` using Frontmatter config: Example of modifying `themeVariables` using frontmatter config:
```mermaid-example ```mermaid-example
--- ---