Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Allenice committed Dec 18, 2023
1 parent b73006c commit bbc01e7
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/guide/other.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ yarn global add @yzfe/svgicon-viewer
svgicon-viewer ./src/assets/svg
```

![svgicon-viewer](../../images/svgicon-viewer.png)
![svgicon-viewer](../svgicon-viewer.png)

Use meta.json to add additional information. Currently, only one name field is supported, which can be used to describe the icon.

Expand All @@ -35,7 +35,7 @@ Use meta.json to add additional information. Currently, only one name field is s
svgicon-viewer ./src/assets/svg ./src/assets/svg/meta.json
```

![svgicon-viewer](../../images/svgicon-viewer-meta.png)
![svgicon-viewer](../svgicon-viewer-meta.png)

### Generate static html page

Expand Down
File renamed without changes
File renamed without changes
4 changes: 2 additions & 2 deletions docs/zh/guide/other.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ yarn global add @yzfe/svgicon-viewer
# svgicon-viewer <svgFilePath> [metaFile]
svgicon-viewer ./src/assets/svg
```
![svgicon-viewer](../../images/svgicon-viewer.png)
![svgicon-viewer](../../svgicon-viewer.png)

### meta.json
使用 meta.json 可以添加额外的信息,目前只支持一个 name 字段,可以用来描述图标。默认读取 SVG 文件路径下的 meta.json
Expand All @@ -36,7 +36,7 @@ svgicon-viewer ./src/assets/svg
svgicon-viewer ./src/assets/svg ./src/assets/svg/meta.json
```

![svgicon-viewer](../../images/svgicon-viewer-meta.png)
![svgicon-viewer](../../svgicon-viewer-meta.png)

### 输出静态 html 页面
添加 --output (alias: -o) 会生成静态 html 页面到指定的输出目录
Expand Down

0 comments on commit bbc01e7

Please sign in to comment.