Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sidharthv96 committed Aug 20, 2023
1 parent 83220f0 commit d46307a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 39 deletions.
56 changes: 18 additions & 38 deletions docs/config/setup/modules/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#### Defined in

[config.ts:9](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L9)
[config.ts:8](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L8)

## Functions

Expand All @@ -26,17 +26,17 @@ Pushes in a directive to the configuration

#### Parameters

| Name | Type | Description |
| :---------- | :---- | :----------------------- |
| `directive` | `any` | The directive to push in |
| Name | Type | Description |
| :---------- | :-------------- | :----------------------- |
| `directive` | `MermaidConfig` | The directive to push in |

#### Returns

`void`

#### Defined in

[config.ts:207](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L207)
[config.ts:185](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L185)

---

Expand All @@ -60,7 +60,7 @@ The currentConfig

#### Defined in

[config.ts:153](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L153)
[config.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L131)

---

Expand All @@ -84,7 +84,7 @@ The siteConfig

#### Defined in

[config.ts:100](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L100)
[config.ts:96](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L96)

---

Expand Down Expand Up @@ -118,7 +118,7 @@ The siteConfig

#### Defined in

[config.ts:239](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L239)
[config.ts:215](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L215)

---

Expand Down Expand Up @@ -147,7 +147,7 @@ options in-place

#### Defined in

[config.ts:168](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L168)
[config.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L146)

---

Expand All @@ -167,7 +167,7 @@ options in-place

#### Defined in

[config.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L79)
[config.ts:75](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L75)

---

Expand Down Expand Up @@ -199,27 +199,7 @@ The currentConfig merged with the sanitized conf

#### Defined in

[config.ts:117](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L117)

---

### setDiagramConfig

**setDiagramConfig**(`conf`): `void`

#### Parameters

| Name | Type |
| :----- | :-------------- |
| `conf` | `MermaidConfig` |

#### Returns

`void`

#### Defined in

[config.ts:132](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L132)
[config.ts:113](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L113)

---

Expand Down Expand Up @@ -252,7 +232,7 @@ The new siteConfig

#### Defined in

[config.ts:65](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L65)
[config.ts:61](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L61)

---

Expand All @@ -262,18 +242,18 @@ The new siteConfig

#### Parameters

| Name | Type |
| :------------ | :-------------- |
| `siteCfg` | `MermaidConfig` |
| `_directives` | `any`\[] |
| Name | Type |
| :------------ | :----------------- |
| `siteCfg` | `MermaidConfig` |
| `_directives` | `MermaidConfig`\[] |

#### Returns

`MermaidConfig`

#### Defined in

[config.ts:17](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L17)
[config.ts:15](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L15)

---

Expand All @@ -293,4 +273,4 @@ The new siteConfig

#### Defined in

[config.ts:83](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L83)
[config.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.ts#L79)
2 changes: 1 addition & 1 deletion docs/config/setup/modules/mermaidAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ mermaid.initialize(config);

#### Defined in

[mermaidAPI.ts:668](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L668)
[mermaidAPI.ts:667](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L667)

## Functions

Expand Down

0 comments on commit d46307a

Please sign in to comment.