docs: fix typo 'diagarm'

hikerpig · Feb 5, 2025 · c4dc39c · c4dc39c
1 parent b7c8df0
commit c4dc39c
Show file tree

Hide file tree

Showing 9 changed files with 25 additions and 25 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/...zh-CN/docusaurus-plugin-content-docs/current/advanced/write-a-custom-diagram.md b/...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