Skip to content

Commit 2be4bf3

Browse files
autofix-ci[bot]xinbenlv
authored andcommitted
[autofix.ci] apply automated fixes
1 parent d50002e commit 2be4bf3

2 files changed

Lines changed: 34 additions & 34 deletions

File tree

docs/config/setup/mermaid/interfaces/MermaidConfig.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,23 @@ Defined in: [packages/mermaid/src/config.type.ts:66](https://github.com/mermaid-
1818

1919
> `optional` **altFontFamily**: `string`
2020
21-
Defined in: [packages/mermaid/src/config.type.ts:139](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L139)
21+
Defined in: [packages/mermaid/src/config.type.ts:147](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L147)
2222

2323
---
2424

2525
### architecture?
2626

2727
> `optional` **architecture**: `ArchitectureDiagramConfig`
2828
29-
Defined in: [packages/mermaid/src/config.type.ts:211](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L211)
29+
Defined in: [packages/mermaid/src/config.type.ts:219](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L219)
3030

3131
---
3232

3333
### arrowMarkerAbsolute?
3434

3535
> `optional` **arrowMarkerAbsolute**: `boolean`
3636
37-
Defined in: [packages/mermaid/src/config.type.ts:158](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L158)
37+
Defined in: [packages/mermaid/src/config.type.ts:166](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L166)
3838

3939
Controls whether or arrow markers in html code are absolute paths or anchors.
4040
This matters if you are using base tag settings.
@@ -45,23 +45,23 @@ This matters if you are using base tag settings.
4545

4646
> `optional` **block**: `BlockDiagramConfig`
4747
48-
Defined in: [packages/mermaid/src/config.type.ts:219](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L219)
48+
Defined in: [packages/mermaid/src/config.type.ts:227](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L227)
4949

5050
---
5151

5252
### c4?
5353

5454
> `optional` **c4**: `C4DiagramConfig`
5555
56-
Defined in: [packages/mermaid/src/config.type.ts:216](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L216)
56+
Defined in: [packages/mermaid/src/config.type.ts:224](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L224)
5757

5858
---
5959

6060
### class?
6161

6262
> `optional` **class**: `ClassDiagramConfig`
6363
64-
Defined in: [packages/mermaid/src/config.type.ts:204](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L204)
64+
Defined in: [packages/mermaid/src/config.type.ts:212](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L212)
6565

6666
---
6767

@@ -77,7 +77,7 @@ Defined in: [packages/mermaid/src/config.type.ts:131](https://github.com/mermaid
7777

7878
> `optional` **deterministicIds**: `boolean`
7979
80-
Defined in: [packages/mermaid/src/config.type.ts:191](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L191)
80+
Defined in: [packages/mermaid/src/config.type.ts:199](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L199)
8181

8282
This option controls if the generated ids of nodes in the SVG are
8383
generated randomly or based on a seed.
@@ -93,7 +93,7 @@ should not change unless content is changed.
9393

9494
> `optional` **deterministicIDSeed**: `string`
9595
96-
Defined in: [packages/mermaid/src/config.type.ts:198](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L198)
96+
Defined in: [packages/mermaid/src/config.type.ts:206](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L206)
9797

9898
This option is the optional seed for deterministic ids.
9999
If set to `undefined` but deterministicIds is `true`, a simple number iterator is used.
@@ -151,23 +151,23 @@ Elk specific option affecting how nodes are placed.
151151

152152
> `optional` **er**: `ErDiagramConfig`
153153
154-
Defined in: [packages/mermaid/src/config.type.ts:206](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L206)
154+
Defined in: [packages/mermaid/src/config.type.ts:214](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L214)
155155

156156
---
157157

158158
### flowchart?
159159

160160
> `optional` **flowchart**: `FlowchartDiagramConfig`
161161
162-
Defined in: [packages/mermaid/src/config.type.ts:199](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L199)
162+
Defined in: [packages/mermaid/src/config.type.ts:207](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L207)
163163

164164
---
165165

166166
### fontFamily?
167167

168168
> `optional` **fontFamily**: `string`
169169
170-
Defined in: [packages/mermaid/src/config.type.ts:138](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L138)
170+
Defined in: [packages/mermaid/src/config.type.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L146)
171171

172172
Specifies the font to be used in the rendered diagrams.
173173
Can be any possible CSS `font-family`.
@@ -187,7 +187,7 @@ Defined in: [packages/mermaid/src/config.type.ts:226](https://github.com/mermaid
187187

188188
> `optional` **forceLegacyMathML**: `boolean`
189189
190-
Defined in: [packages/mermaid/src/config.type.ts:180](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L180)
190+
Defined in: [packages/mermaid/src/config.type.ts:188](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L188)
191191

192192
This option forces Mermaid to rely on KaTeX's own stylesheet for rendering MathML. Due to differences between OS
193193
fonts and browser's MathML implementation, this option is recommended if consistent rendering is important.
@@ -199,15 +199,15 @@ If set to true, ignores legacyMathML.
199199

200200
> `optional` **gantt**: `GanttDiagramConfig`
201201
202-
Defined in: [packages/mermaid/src/config.type.ts:201](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L201)
202+
Defined in: [packages/mermaid/src/config.type.ts:209](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L209)
203203

204204
---
205205

206206
### gitGraph?
207207

208208
> `optional` **gitGraph**: `GitGraphDiagramConfig`
209209
210-
Defined in: [packages/mermaid/src/config.type.ts:215](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L215)
210+
Defined in: [packages/mermaid/src/config.type.ts:223](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L223)
211211

212212
---
213213

@@ -225,7 +225,7 @@ Defines the seed to be used when using handDrawn look. This is important for the
225225

226226
> `optional` **htmlLabels**: `boolean`
227227
228-
Defined in: [packages/mermaid/src/config.type.ts:131](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L131)
228+
Defined in: [packages/mermaid/src/config.type.ts:139](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L139)
229229

230230
Flag for setting whether or not a html tag should be used for rendering labels on nodes and edges.
231231
**Note:** Diagram-specific `htmlLabels` settings (e.g., `flowchart.htmlLabels`) are deprecated.
@@ -238,23 +238,23 @@ over any diagram-specific settings.
238238

239239
> `optional` **ishikawa**: `IshikawaDiagramConfig`
240240
241-
Defined in: [packages/mermaid/src/config.type.ts:213](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L213)
241+
Defined in: [packages/mermaid/src/config.type.ts:221](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L221)
242242

243243
---
244244

245245
### journey?
246246

247247
> `optional` **journey**: `JourneyDiagramConfig`
248248
249-
Defined in: [packages/mermaid/src/config.type.ts:202](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L202)
249+
Defined in: [packages/mermaid/src/config.type.ts:210](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L210)
250250

251251
---
252252

253253
### kanban?
254254

255255
> `optional` **kanban**: `KanbanDiagramConfig`
256256
257-
Defined in: [packages/mermaid/src/config.type.ts:214](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L214)
257+
Defined in: [packages/mermaid/src/config.type.ts:222](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L222)
258258

259259
---
260260

@@ -272,7 +272,7 @@ Defines which layout algorithm to use for rendering the diagram.
272272

273273
> `optional` **legacyMathML**: `boolean`
274274
275-
Defined in: [packages/mermaid/src/config.type.ts:173](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L173)
275+
Defined in: [packages/mermaid/src/config.type.ts:181](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L181)
276276

277277
This option specifies if Mermaid can expect the dependent to include KaTeX stylesheets for browsers
278278
without their own MathML implementation. If this option is disabled and MathML is not supported, the math
@@ -285,7 +285,7 @@ fall back to legacy rendering for KaTeX.
285285

286286
> `optional` **logLevel**: `0` | `2` | `1` | `"trace"` | `"debug"` | `"info"` | `"warn"` | `"error"` | `"fatal"` | `3` | `4` | `5`
287287
288-
Defined in: [packages/mermaid/src/config.type.ts:144](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L144)
288+
Defined in: [packages/mermaid/src/config.type.ts:152](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L152)
289289

290290
This option decides the amount of logging to be used by mermaid.
291291

@@ -333,31 +333,31 @@ The maximum allowed size of the users text diagram
333333

334334
> `optional` **mindmap**: `MindmapDiagramConfig`
335335
336-
Defined in: [packages/mermaid/src/config.type.ts:212](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L212)
336+
Defined in: [packages/mermaid/src/config.type.ts:220](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L220)
337337

338338
---
339339

340340
### packet?
341341

342342
> `optional` **packet**: `PacketDiagramConfig`
343343
344-
Defined in: [packages/mermaid/src/config.type.ts:218](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L218)
344+
Defined in: [packages/mermaid/src/config.type.ts:226](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L226)
345345

346346
---
347347

348348
### pie?
349349

350350
> `optional` **pie**: `PieDiagramConfig`
351351
352-
Defined in: [packages/mermaid/src/config.type.ts:207](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L207)
352+
Defined in: [packages/mermaid/src/config.type.ts:215](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L215)
353353

354354
---
355355

356356
### quadrantChart?
357357

358358
> `optional` **quadrantChart**: `QuadrantChartConfig`
359359
360-
Defined in: [packages/mermaid/src/config.type.ts:208](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L208)
360+
Defined in: [packages/mermaid/src/config.type.ts:216](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L216)
361361

362362
---
363363

@@ -373,23 +373,23 @@ Defined in: [packages/mermaid/src/config.type.ts:221](https://github.com/mermaid
373373

374374
> `optional` **requirement**: `RequirementDiagramConfig`
375375
376-
Defined in: [packages/mermaid/src/config.type.ts:210](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L210)
376+
Defined in: [packages/mermaid/src/config.type.ts:218](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L218)
377377

378378
---
379379

380380
### sankey?
381381

382382
> `optional` **sankey**: `SankeyDiagramConfig`
383383
384-
Defined in: [packages/mermaid/src/config.type.ts:217](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L217)
384+
Defined in: [packages/mermaid/src/config.type.ts:225](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L225)
385385

386386
---
387387

388388
### secure?
389389

390390
> `optional` **secure**: `string`\[]
391391
392-
Defined in: [packages/mermaid/src/config.type.ts:165](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L165)
392+
Defined in: [packages/mermaid/src/config.type.ts:173](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L173)
393393

394394
This option controls which `currentConfig` keys are considered secure and
395395
can only be changed via call to `mermaid.initialize`.
@@ -401,7 +401,7 @@ This prevents malicious graph directives from overriding a site's default securi
401401

402402
> `optional` **securityLevel**: `"strict"` | `"loose"` | `"antiscript"` | `"sandbox"`
403403
404-
Defined in: [packages/mermaid/src/config.type.ts:148](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L148)
404+
Defined in: [packages/mermaid/src/config.type.ts:156](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L156)
405405

406406
Level of trust for parsed diagram
407407

@@ -411,15 +411,15 @@ Level of trust for parsed diagram
411411

412412
> `optional` **sequence**: `SequenceDiagramConfig`
413413
414-
Defined in: [packages/mermaid/src/config.type.ts:200](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L200)
414+
Defined in: [packages/mermaid/src/config.type.ts:208](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L208)
415415

416416
---
417417

418418
### startOnLoad?
419419

420420
> `optional` **startOnLoad**: `boolean`
421421
422-
Defined in: [packages/mermaid/src/config.type.ts:152](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L152)
422+
Defined in: [packages/mermaid/src/config.type.ts:160](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L160)
423423

424424
Dictates whether mermaid starts on Page load
425425

@@ -429,7 +429,7 @@ Dictates whether mermaid starts on Page load
429429

430430
> `optional` **state**: `StateDiagramConfig`
431431
432-
Defined in: [packages/mermaid/src/config.type.ts:205](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L205)
432+
Defined in: [packages/mermaid/src/config.type.ts:213](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L213)
433433

434434
---
435435

@@ -475,7 +475,7 @@ Defined in: [packages/mermaid/src/config.type.ts:73](https://github.com/mermaid-
475475

476476
> `optional` **timeline**: `TimelineDiagramConfig`
477477
478-
Defined in: [packages/mermaid/src/config.type.ts:203](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L203)
478+
Defined in: [packages/mermaid/src/config.type.ts:211](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L211)
479479

480480
---
481481

@@ -515,4 +515,4 @@ Defined in: [packages/mermaid/src/config.type.ts:225](https://github.com/mermaid
515515

516516
> `optional` **xyChart**: `XYChartConfig`
517517
518-
Defined in: [packages/mermaid/src/config.type.ts:209](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L209)
518+
Defined in: [packages/mermaid/src/config.type.ts:217](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/config.type.ts#L217)

packages/mermaid/src/config.type.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1611,7 +1611,7 @@ export interface SankeyDiagramConfig extends BaseDiagramConfig {
16111611
*/
16121612
nodePadding?: number;
16131613
/**
1614-
* The style of labels in the sankey diagram. 'default' provides better readability with a white stroke behind the text.
1614+
* The style of labels in the sankey diagram. 'outlined' provides better readability with a white stroke behind the text.
16151615
*
16161616
*/
16171617
labelStyle?: 'default' | 'legacy';

0 commit comments

Comments
 (0)