Revert "chore: add missing buildSVG func in the usage doc"

This reverts commit c729313.
hikerpig · Oct 25, 2023 · 7dd01b3 · 7dd01b3
1 parent 269b1ca
commit 7dd01b3
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 29 deletions.
diff --git a/packages/pintora-cli/src/render.ts b/packages/pintora-cli/src/render.ts
@@ -6,21 +6,13 @@ import { Canvas, CanvasPattern } from 'canvas'
 import { SVG_MIME_TYPE, DEFAUT_BGS } from './const'
 
 export type CLIRenderOptions = {
-  /**
-   * pintora DSL to render
-   */
   code: string
   devicePixelRatio?: number | null
   mimeType?: string
-  /**
-   * Assign extra background color
-   */
   backgroundColor?: string
   pintoraConfig?: Partial<PintoraConfig>
-  /**
-   * width of the output, height will be calculated according to the diagram content ratio
-   */
   width?: number
+  // height?: number
 }
 
 function renderPrepare(opts: CLIRenderOptions) {

diff --git a/website/docs/advanced/api-usage.md b/website/docs/advanced/api-usage.md
@@ -140,20 +140,11 @@ It's a little bit more complicated in Node.js than in the browser, we need to bo
 
 ```ts
 export type CLIRenderOptions = {
-  /**
-   * pintora DSL to render
-   */
   code: string
   devicePixelRatio?: number | null
   mimeType?: string
-  /**
-   * Assign extra background color
-   */
   backgroundColor?: string
   pintoraConfig?: Partial<PintoraConfig>
-  /**
-   * width of the output, height will be calculated according to the diagram content ratio
-   */
   width?: number
 }
 
@@ -172,17 +163,6 @@ Some example code:
 import { render, PintoraConfig } from '@pintora/cli'
 import * as fs from 'fs'
 
-const buildSVG = async (code: string, config?: Partial<PintoraConfig>) => {
-  const str = await render({
-    code: code,
-    pintoraConfig: config,
-    mimeType: 'image/svg+xml',
-    width: 1000,
-    backgroundColor: '#fff',
-  })
-  fs.writeFileSync('example.svg', str)
-}
-
 const buildPNG = async (code: string, config?: Partial<PintoraConfig>) => {
   const buf = await render({
     code: code,