chore: update docs

digitalacorn · Aug 20, 2022 · 4b22315 · 4b22315
1 parent 3a57f97
commit 4b22315
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -204,13 +204,14 @@ import ids from 'virtual:svg-icons-names'
 
 ### Options
 
-| Parameter   | Type                   | Default               | Description                                                                           |
-| ----------- | ---------------------- | --------------------- | ------------------------------------------------------------------------------------- |
-| iconDirs    | `string[]`             | -                     | Need to generate the icon folder of the Sprite image                                  |
-| symbolId    | `string`               | `icon-[dir]-[name]`   | svg symbolId format, see the description below                                        |
-| svgoOptions | `boolean｜SvgoOptions` | `true`                | svg compression configuration, can be an object[Options](https://github.com/svg/svgo) |
-| inject      | `string`               | `body-last`           | svgDom default insertion position, optional `body-first`                              |
-| customDomId | `string`               | `__svg__icons__dom__` | Customize the ID of the svgDom insert node                                            |
+| Parameter                     | Type                   | Default               | Description                                                                           |
+| ----------------------------- | ---------------------- | --------------------- | ------------------------------------------------------------------------------------- |
+| iconDirs                      | `string[]`             | -                     | Need to generate the icon folder of the Sprite image                                  |
+| symbolId                      | `string`               | `icon-[dir]-[name]`   | svg symbolId format, see the description below                                        |
+| svgoOptions                   | `boolean｜SvgoOptions` | `true`                | svg compression configuration, can be an object[Options](https://github.com/svg/svgo) |
+| inject                        | `string`               | `body-last`           | svgDom default insertion position, optional `body-first`                              |
+| customDomId                   | `string`               | `__svg__icons__dom__` | Customize the ID of the svgDom insert node                                            |
+| replaceStrokeWithCurrentColor | `boolean`              | `true`                | Whether to perform a replacement of stroke colors with currentColor                   |
 
 **symbolId**
 

diff --git a/README.zh_CN.md b/README.zh_CN.md
@@ -175,13 +175,14 @@ import ids from 'virtual:svg-icons-names'
 
 ### 配置说明
 
-| 参数        | 类型                   | 默认值                | 说明                                                           |
-| ----------- | ---------------------- | --------------------- | -------------------------------------------------------------- |
-| iconDirs    | `string[]`             | -                     | 需要生成雪碧图的图标文件夹                                     |
-| symbolId    | `string`               | `icon-[dir]-[name]`   | svg 的 symbolId 格式，见下方说明                               |
-| svgoOptions | `boolean｜SvgoOptions` | `true`                | svg 压缩配置，可以是对象[Options](https://github.com/svg/svgo) |
-| inject      | `string`               | `body-last`           | svgDom 默认插入的位置，可选`body-first`                        |
-| customDomId | `string`               | `__svg__icons__dom__` | svgDom 插入节点的 ID                                           |
+| 参数                          | 类型                   | 默认值                | 说明                                                           |
+| ----------------------------- | ---------------------- | --------------------- | -------------------------------------------------------------- |
+| iconDirs                      | `string[]`             | -                     | 需要生成雪碧图的图标文件夹                                     |
+| symbolId                      | `string`               | `icon-[dir]-[name]`   | svg 的 symbolId 格式，见下方说明                               |
+| svgoOptions                   | `boolean｜SvgoOptions` | `true`                | svg 压缩配置，可以是对象[Options](https://github.com/svg/svgo) |
+| inject                        | `string`               | `body-last`           | svgDom 默认插入的位置，可选`body-first`                        |
+| customDomId                   | `string`               | `__svg__icons__dom__` | svgDom 插入节点的 ID                                           |
+| replaceStrokeWithCurrentColor | `boolean`              | `true`                | -                                                              |
 
 **symbolId**