marcel/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-10-02 21:59:39 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge from upstream mermaid os develop

Browse Source
This commit is contained in:
Ashish Jain
2024-10-09 11:19:40 +02:00
parent aa91874d9e 2b86750cb3
commit c73f8d0990
124 changed files with 3398 additions and 1119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/config/setup/interfaces/mermaid.ParseResult.md
View File

@@ -8,60 +8,68 @@
[mermaid](../modules/mermaid.md).ParseResult
## Hierarchy
- `Omit`<`ParseResult`, `"config"`>
↳ **`ParseResult`**
## Properties
### code
• **code**: `string`
The mermaid code after extracting the config.
#### Defined in
[packages/mermaid/src/types.ts:66](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L66)
---
### config
• **config**: [`MermaidConfig`](mermaid.MermaidConfig.md)
#### Defined in
[packages/mermaid/src/mermaid.ts:328](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L328)
---
### defaultConfig
• **defaultConfig**: [`MermaidConfig`](mermaid.MermaidConfig.md)
#### Overrides
Omit.defaultConfig
The config passed as YAML frontmatter or directives
#### Defined in
[packages/mermaid/src/types.ts:67](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L67)
[packages/mermaid/src/types.ts:70](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L70)
---
### diagram
• **diagram**: `Diagram`
The diagram AST
#### Inherited from
Omit.diagram
• `Optional` **diagram**: `Diagram`
#### Defined in
[packages/mermaid/src/types.ts:63](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L63)
[packages/mermaid/src/types.ts:72](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L72)
---
### userConfig
### error
• **userConfig**: [`MermaidConfig`](mermaid.MermaidConfig.md)
• `Optional` **error**: `unknown`
Config the user has defined in the text as frontmatter or directives
The error that occurred during parsing, if any.
#### Defined in
[packages/mermaid/src/mermaid.ts:326](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaid.ts#L326)
[packages/mermaid/src/types.ts:76](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L76)
---
### success
• **success**: `boolean`
#### Defined in
[packages/mermaid/src/types.ts:62](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L62)
---
### title
• `Optional` **title**: `string`
#### Defined in
[packages/mermaid/src/types.ts:71](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/types.ts#L71)