From c4dc39c97cc680d0a4b55fe7de1c0bdc64a90b1d Mon Sep 17 00:00:00 2001 From: hikerpig Date: Wed, 5 Feb 2025 21:12:55 +0800 Subject: [PATCH] docs: fix typo 'diagarm' --- .../docs/advanced/write-a-custom-diagram.md | 18 +++++++++--------- website/docs/diagrams/activity-diagram.mdx | 2 +- website/docs/diagrams/class-diagram.mdx | 2 +- website/docs/diagrams/component-diagram.mdx | 2 +- website/docs/diagrams/er-diagram.mdx | 2 +- website/docs/diagrams/gantt-diagram.mdx | 2 +- website/docs/diagrams/mindmap.mdx | 2 +- website/docs/diagrams/sequence-diagram.mdx | 2 +- .../current/advanced/write-a-custom-diagram.md | 18 +++++++++--------- 9 files changed, 25 insertions(+), 25 deletions(-) diff --git a/website/docs/advanced/write-a-custom-diagram.md b/website/docs/advanced/write-a-custom-diagram.md index 3b092042..8c6f93b4 100644 --- a/website/docs/advanced/write-a-custom-diagram.md +++ b/website/docs/advanced/write-a-custom-diagram.md @@ -178,13 +178,13 @@ const LEGEND_FONT: IFont = { } type PieConf = { - diagarmPadding: number + diagramPadding: number diagramBackgroundColor: string circleRadius: number } const conf: PieConf = { - diagarmPadding: 10, + diagramPadding: 10, diagramBackgroundColor: '#F9F9F9', circleRadius: 150, } @@ -198,8 +198,8 @@ const conf: PieConf = { ```ts const radius = conf.circleRadius - let circleStartY = conf.diagarmPadding - let circleStartX = conf.diagarmPadding + let circleStartY = conf.diagramPadding + let circleStartX = conf.diagramPadding if (diagramIR.title) { const titleMark = pintora.util.makeMark('text', { @@ -319,12 +319,12 @@ Notice the `class` attribute on `itemGroup`, which will be carried in the SVG ou At this point, the final `graphicsIR` is complete with all the required data. ```ts - const diagramWidth = maxLabelRight + conf.diagarmPadding + const diagramWidth = maxLabelRight + conf.diagramPadding const graphicsIR: GraphicsIR = { mark: rootMark, width: diagramWidth, - height: circleStartY + 2 * radius + conf.diagarmPadding, + height: circleStartY + 2 * radius + conf.diagramPadding, bgColor: conf.diagramBackgroundColor, } ``` @@ -339,7 +339,7 @@ With Typescript's type enhancement feature, you can extend the `interface Pintor declare module '@pintora/core' { interface PintoraConfig { pie: { - diagarmPadding: number + diagramPadding: number diagramBackgroundColor: string circleRadius: number pieColors: string[] @@ -366,7 +366,7 @@ import pintora, { IFont, PintoraConfig } from '@pintora/standalone' } -type PieConf = { -- diagarmPadding: number +- diagramPadding: number - diagramBackgroundColor: string - circleRadius: number -} @@ -375,7 +375,7 @@ import pintora, { IFont, PintoraConfig } from '@pintora/standalone' -const conf: PieConf = { +// default config +const defaultConfig: PieConf = { - diagarmPadding: 10, + diagramPadding: 10, diagramBackgroundColor: '#F9F9F9', circleRadius: 150, + pieColors: DEFAULT_PIE_COLORS diff --git a/website/docs/diagrams/activity-diagram.mdx b/website/docs/diagrams/activity-diagram.mdx index 36025a5d..d2408ca6 100644 --- a/website/docs/diagrams/activity-diagram.mdx +++ b/website/docs/diagrams/activity-diagram.mdx @@ -228,7 +228,7 @@ activityDiagram ## Override config -You can override diagarm config through `@param` directive. +You can override diagram config through `@param` directive. All available configs can be seen in the [Config page](../configuration/config.md#activity). diff --git a/website/docs/diagrams/class-diagram.mdx b/website/docs/diagrams/class-diagram.mdx index b4a21da9..e91569f7 100644 --- a/website/docs/diagrams/class-diagram.mdx +++ b/website/docs/diagrams/class-diagram.mdx @@ -126,7 +126,7 @@ classDiagram ## Override config -You can override diagarm config through `@param` directive. +You can override diagram config through `@param` directive. All available configs can be seen in the [Config page](../configuration/config.md#class). diff --git a/website/docs/diagrams/component-diagram.mdx b/website/docs/diagrams/component-diagram.mdx index 9873b6ac..4312dd58 100644 --- a/website/docs/diagrams/component-diagram.mdx +++ b/website/docs/diagrams/component-diagram.mdx @@ -87,7 +87,7 @@ database "MySql" { ## Override config -You can override diagarm config through `@param` directive. +You can override diagram config through `@param` directive. All available configs can be seen in the [Config page](../configuration/config.md#component). diff --git a/website/docs/diagrams/er-diagram.mdx b/website/docs/diagrams/er-diagram.mdx index 0a685e72..f961a6e2 100644 --- a/website/docs/diagrams/er-diagram.mdx +++ b/website/docs/diagrams/er-diagram.mdx @@ -93,7 +93,7 @@ erDiagram ## Override config -You can override diagarm config through `@param` directive. +You can override diagram config through `@param` directive. All available configs can be seen in the [Config page](../configuration/config.md#er). diff --git a/website/docs/diagrams/gantt-diagram.mdx b/website/docs/diagrams/gantt-diagram.mdx index 0fc3d3bd..78b146de 100644 --- a/website/docs/diagrams/gantt-diagram.mdx +++ b/website/docs/diagrams/gantt-diagram.mdx @@ -116,7 +116,7 @@ gantt ## Override config -You can override diagarm config through `@param` directive. +You can override diagram config through `@param` directive. All available configs can be seen in the [Config page](../configuration/config.md#gantt). diff --git a/website/docs/diagrams/mindmap.mdx b/website/docs/diagrams/mindmap.mdx index 0b8b6def..c5372873 100644 --- a/website/docs/diagrams/mindmap.mdx +++ b/website/docs/diagrams/mindmap.mdx @@ -63,7 +63,7 @@ mindmap ## Override config -You can override diagarm config through `@param` directive. +You can override diagram config through `@param` directive. All available configs can be seen in the [Config page](../configuration/config.md#mindmap). diff --git a/website/docs/diagrams/sequence-diagram.mdx b/website/docs/diagrams/sequence-diagram.mdx index 5e60d232..bf9e3b05 100644 --- a/website/docs/diagrams/sequence-diagram.mdx +++ b/website/docs/diagrams/sequence-diagram.mdx @@ -134,7 +134,7 @@ sequenceDiagram ## Override config -You can override diagarm config through `@param` directive. +You can override diagram config through `@param` directive. All available configs can be seen in the [Config page](../configuration/config.md#sequence). diff --git a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/advanced/write-a-custom-diagram.md b/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/advanced/write-a-custom-diagram.md index af93f2c5..c2218af2 100644 --- a/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/advanced/write-a-custom-diagram.md +++ b/website/i18n/zh-CN/docusaurus-plugin-content-docs/current/advanced/write-a-custom-diagram.md @@ -178,13 +178,13 @@ const LEGEND_FONT: IFont = { } type PieConf = { - diagarmPadding: number + diagramPadding: number diagramBackgroundColor: string circleRadius: number } const conf: PieConf = { - diagarmPadding: 10, + diagramPadding: 10, diagramBackgroundColor: '#F9F9F9', circleRadius: 150, } @@ -198,8 +198,8 @@ const conf: PieConf = { ```ts const radius = conf.circleRadius - let circleStartY = conf.diagarmPadding - let circleStartX = conf.diagarmPadding + let circleStartY = conf.diagramPadding + let circleStartX = conf.diagramPadding if (diagramIR.title) { const titleMark = pintora.util.makeMark('text', { @@ -319,12 +319,12 @@ const conf: PieConf = { 到这里，最终的 `graphicsIR` 所需数据便全部完成了。 ```ts - const diagramWidth = maxLabelRight + conf.diagarmPadding + const diagramWidth = maxLabelRight + conf.diagramPadding const graphicsIR: GraphicsIR = { mark: rootMark, width: diagramWidth, - height: circleStartY + 2 * radius + conf.diagarmPadding, + height: circleStartY + 2 * radius + conf.diagramPadding, bgColor: conf.diagramBackgroundColor, } ``` @@ -339,7 +339,7 @@ const conf: PieConf = { declare module '@pintora/core' { interface PintoraConfig { pie: { - diagarmPadding: number + diagramPadding: number diagramBackgroundColor: string circleRadius: number pieColors: string[] @@ -366,7 +366,7 @@ import pintora, { IFont, PintoraConfig } from '@pintora/standalone' } -type PieConf = { -- diagarmPadding: number +- diagramPadding: number - diagramBackgroundColor: string - circleRadius: number -} @@ -375,7 +375,7 @@ import pintora, { IFont, PintoraConfig } from '@pintora/standalone' -const conf: PieConf = { +// default config +const defaultConfig: PieConf = { - diagarmPadding: 10, + diagramPadding: 10, diagramBackgroundColor: '#F9F9F9', circleRadius: 150, + pieColors: DEFAULT_PIE_COLORS