From 32ebc4676e0c3a7e5516980f9c8dc98685a2b282 Mon Sep 17 00:00:00 2001 From: hemengke <23536175@qq.com> Date: Wed, 9 Oct 2024 14:03:49 +0800 Subject: [PATCH] docs: update --- README.md | 14 +++++--- README.zh.md | 15 +++++--- docs/vscode-configuration.en.md | 32 ----------------- docs/vscode-configuration.md | 62 ++++++++++++++++----------------- docs/vscode-configuration.zh.md | 32 +++++++++++++++++ package.json | 2 +- 6 files changed, 85 insertions(+), 72 deletions(-) delete mode 100644 docs/vscode-configuration.en.md create mode 100644 docs/vscode-configuration.zh.md diff --git a/README.md b/README.md index e332dfc3..44da83b4 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

Image Manager

-> Compress, crop, convert formats, search, and find similar images in VS Code +> View, compress, crop, convert formats, search, and find similar images in VS Code [中文文档](./README.zh.md) @@ -89,19 +89,25 @@ Right-click in Explorer, select `Image Manager` to open the extension (opens the Press `Ctrl+Shift+P` (macOS: `Cmd+Shift+P`), type `Image Manager` to open (opens the workspace root folder). -## [Extension Configurations](./docs/vscode-configuration.en.md) +## [Extension Configurations](./docs//vscode-configuration.md) ## Tips ### Compression -- Right-click on the image +
+ Right-click on the image ![compress-right-click-image](./screenshots/compress-1.png) +
-- Right-click on the folder +
+ Right-click on the folder ![compress-right-click-folder](./screenshots/compress-2.png) +
+ + ### Viewer diff --git a/README.zh.md b/README.zh.md index dad94fe5..20d11a85 100644 --- a/README.zh.md +++ b/README.zh.md @@ -6,7 +6,7 @@

Image Manager

-> 压缩、裁剪、转换格式、搜索、查找相似图片的 VS Code 插件 +> 浏览、压缩、裁剪、转换格式、搜索、查找相似图片的 VS Code 插件 [English Docs](./README.md) @@ -92,7 +92,7 @@ 按 `Ctrl+Shift+P`（macOS: `Cmd+Shift+P`）打开命令面板，输入 `Image Manager` 并选择打开。 -## [插件配置项](./docs/vscode-configuration.md) +## [插件配置项](./docs/vscode-configuration.zh.md) ## 小贴士 @@ -102,14 +102,21 @@ ### 压缩 -- 在图片上右键，可以单独压缩一张图片。 +
+ 在图片上右键，可以压缩单张图片 ![compress-right-click-image](./screenshots/compress-cn-1.png) -- 在文件夹上右键，可以批量压缩文件夹下的图片。 +
+ + +
+ 在文件夹上右键，可以批量压缩文件夹下的所有图片 ![compress-right-click-folder](./screenshots/compress-cn-2.png) +
+ ### 浏览区域 - `Cmd/Ctrl + 鼠标滚轮` 可以缩放图片大小。 diff --git a/docs/vscode-configuration.en.md b/docs/vscode-configuration.en.md deleted file mode 100644 index d817da11..00000000 --- a/docs/vscode-configuration.en.md +++ /dev/null @@ -1,32 +0,0 @@ -# Extension Configurations - -| Name | Type | Description | Default value | -| ---------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | -| image-manager.file.root | `string[]` | Root folder to scan images | current workspace | -| image-manager.file.exclude | `string[]` | Scan images not in exclude | `['**/node_modules/**','**/.git/**',`
`'**/dist/**','**/coverage/**','**/.next/**',`
`'**/.nuxt/**','**/.vercel/**']` | -| image-manager.file.scan | `string[]` | Scan images with imageType | `['svg','png','jpeg','jpg',`
`'ico','gif','webp','bmp',`
`'tif','tiff','apng','avif']` | -| image-manager.file.confirmDelete | `boolean` | Controls whether ask for confirmation when deleting a image | true | -| image-manager.file.revealFileInOsDeeply | `boolean` | Enter folder when it is revealed in OS | true | -| image-manager.appearance.theme | `dark \| light \| auto` | Theme | `auto` | -| image-manager.appearance.language | `en \| zh-CN \| zh-TW \| ja \| auto` | Language | `auto` | -| image-manager.appearance.primaryColor | `string` | Primary color | undefined | -| image-manager.viewer.warningSize | `number \| boolean` | Show warning dot if image size is larger than this value (KB) | 1024 | -| image-manager.viewer.imageWidth | `number` | Width of image (px) | 100 | -| image-manager.viewer.imageBackgroundColor | `string` | Image background color | `#1a1a1a` | -| image-manager.viewer.imageRendering | `auto \| crisp-edges \| pixelated` | Image rendering | `auto` | -| image-manager.mirror.enabled | `boolean` | Use mirror for downloading dependencies | false | -| image-manager.mirror.url | `string` | Custom mirror url (No need to custom this in general) | undefined | -| image-manager.compression.errorRange | `number` | Error range (KB), exceeding this range is considered an increase in image size after compression | 2 | -| image-manager.compression.keepOriginal | `boolean` | Keep original image after compression | false | -| image-manager.compression.fileSuffix | `string` | Add suffix to compressed image | `.min` | -| image-manager.compression.skipCompressed | `boolean` | Skip the compressed images | true | -| image-manager.compression.quality | `number` | Compression quality | - | -| image-manager.compression.size | `number` | Image size (x scale factor) | 1 | -| image-manager.compression.format | `string` | Convert format after compression | '' | -| image-manager.compression.png.compressionLevel | `number` | Compression level of png | 9 | -| image-manager.compression.gif.colors | `number` | Image colors of gif | 256 | -| image-manager.compression.svg.\* | `svgo 配置` | Svgo config. Please refer to svgo offical docs | - | -| image-manager.conversion.format | `string` | Convert format | '' | -| image-manager.conversion.keepOriginal | `boolean` | Keep original image after format conversion | false | -| image-manager.conversion.icoSize | `number[]` | Size of ico | [16, 32] | -| image-manager.similarity.precision | `number` | Determining the precision of image similarity. The smaller the value, the stricter the judgment | 10 | diff --git a/docs/vscode-configuration.md b/docs/vscode-configuration.md index 4a18e2c5..d817da11 100644 --- a/docs/vscode-configuration.md +++ b/docs/vscode-configuration.md @@ -1,32 +1,32 @@ -# 插件配置项 +# Extension Configurations -| 配置项名称 | 数据类型 | 描述 | 默认值 | -| ---------------------------------------------- | ------------------------------------ | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | -| image-manager.file.root | `string[]` | 扫描图片的根目录 | 当前工作区 | -| image-manager.file.exclude | `string[]` | 排除目录 | `['**/node_modules/**','**/.git/**',`
`'**/dist/**','**/coverage/**','**/.next/**',`
`'**/.nuxt/**','**/.vercel/**']` | -| image-manager.file.scan | `string[]` | 扫描的图片类型 | `['svg','png','jpeg','jpg',`
`'ico','gif','webp','bmp',`
`'tif','tiff','apng','avif']` | -| image-manager.file.confirmDelete | `boolean` | 删除图片时是否询问 | true | -| image-manager.file.revealFileInOsDeeply | `boolean` | 在OS中显示文件夹时进入到文件夹中 | false | -| image-manager.appearance.theme | `dark \| light \| auto` | 主题 | `auto` | -| image-manager.appearance.language | `en \| zh-CN \| zh-TW \| ja \| auto` | 语言 | `auto` | -| image-manager.appearance.primaryColor | `string` | 主题色 | undefined | -| image-manager.viewer.warningSize | `number \| boolean` | 当图片体积大于此值时右上角展示警告点（KB） | 1024 | -| image-manager.viewer.imageWidth | `number` | 图片宽度（px） | 100 | -| image-manager.viewer.imageBackgroundColor | `string` | 图片背景色 | `#1a1a1a` | -| image-manager.viewer.imageRendering | `auto \| crisp-edges \| pixelated` | 图片渲染方式（可自行调整像素风） | `auto` | -| image-manager.mirror.enabled | `boolean` | 使用镜像下载依赖 | false | -| image-manager.mirror.url | `string` | 镜像地址（通常情况不需要自定义） | undefined | -| image-manager.compression.errorRange | `number` | 误差范围（KB），超出此误差视为图片压缩后增大 | 2 | -| image-manager.compression.keepOriginal | `boolean` | 压缩后保留原图 | false | -| image-manager.compression.fileSuffix | `string` | 压缩图片文件名添加后缀 | `.min` | -| image-manager.compression.skipCompressed | `boolean` | 跳过已压缩的图片 | true | -| image-manager.compression.quality | `number` | 压缩图片质量 | - | -| image-manager.compression.size | `number` | 图片尺寸（几倍图） | 1 | -| image-manager.compression.format | `string` | 压缩时转化图片的格式 | '' | -| image-manager.compression.png.compressionLevel | `number` | png图片压缩等级 | 9 | -| image-manager.compression.gif.colors | `number` | gif图片色彩 | 256 | -| image-manager.compression.svg.\* | `svgo 配置` | 压缩svg的配置，具体配置项功能请参考svgo官方文档 | - | -| image-manager.conversion.format | `string` | 转化图片格式 | '' | -| image-manager.conversion.keepOriginal | `boolean` | 转化图片格式后保留原图 | false | -| image-manager.conversion.icoSize | `number[]` | ico图标尺寸 | [16, 32] | -| image-manager.similarity.precision | `number` | 判断图片相似的精确度。值越小，判断越严格 | 10 | +| Name | Type | Description | Default value | +| ---------------------------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | +| image-manager.file.root | `string[]` | Root folder to scan images | current workspace | +| image-manager.file.exclude | `string[]` | Scan images not in exclude | `['**/node_modules/**','**/.git/**',`
`'**/dist/**','**/coverage/**','**/.next/**',`
`'**/.nuxt/**','**/.vercel/**']` | +| image-manager.file.scan | `string[]` | Scan images with imageType | `['svg','png','jpeg','jpg',`
`'ico','gif','webp','bmp',`
`'tif','tiff','apng','avif']` | +| image-manager.file.confirmDelete | `boolean` | Controls whether ask for confirmation when deleting a image | true | +| image-manager.file.revealFileInOsDeeply | `boolean` | Enter folder when it is revealed in OS | true | +| image-manager.appearance.theme | `dark \| light \| auto` | Theme | `auto` | +| image-manager.appearance.language | `en \| zh-CN \| zh-TW \| ja \| auto` | Language | `auto` | +| image-manager.appearance.primaryColor | `string` | Primary color | undefined | +| image-manager.viewer.warningSize | `number \| boolean` | Show warning dot if image size is larger than this value (KB) | 1024 | +| image-manager.viewer.imageWidth | `number` | Width of image (px) | 100 | +| image-manager.viewer.imageBackgroundColor | `string` | Image background color | `#1a1a1a` | +| image-manager.viewer.imageRendering | `auto \| crisp-edges \| pixelated` | Image rendering | `auto` | +| image-manager.mirror.enabled | `boolean` | Use mirror for downloading dependencies | false | +| image-manager.mirror.url | `string` | Custom mirror url (No need to custom this in general) | undefined | +| image-manager.compression.errorRange | `number` | Error range (KB), exceeding this range is considered an increase in image size after compression | 2 | +| image-manager.compression.keepOriginal | `boolean` | Keep original image after compression | false | +| image-manager.compression.fileSuffix | `string` | Add suffix to compressed image | `.min` | +| image-manager.compression.skipCompressed | `boolean` | Skip the compressed images | true | +| image-manager.compression.quality | `number` | Compression quality | - | +| image-manager.compression.size | `number` | Image size (x scale factor) | 1 | +| image-manager.compression.format | `string` | Convert format after compression | '' | +| image-manager.compression.png.compressionLevel | `number` | Compression level of png | 9 | +| image-manager.compression.gif.colors | `number` | Image colors of gif | 256 | +| image-manager.compression.svg.\* | `svgo 配置` | Svgo config. Please refer to svgo offical docs | - | +| image-manager.conversion.format | `string` | Convert format | '' | +| image-manager.conversion.keepOriginal | `boolean` | Keep original image after format conversion | false | +| image-manager.conversion.icoSize | `number[]` | Size of ico | [16, 32] | +| image-manager.similarity.precision | `number` | Determining the precision of image similarity. The smaller the value, the stricter the judgment | 10 | diff --git a/docs/vscode-configuration.zh.md b/docs/vscode-configuration.zh.md new file mode 100644 index 00000000..4a18e2c5 --- /dev/null +++ b/docs/vscode-configuration.zh.md @@ -0,0 +1,32 @@ +# 插件配置项 + +| 配置项名称 | 数据类型 | 描述 | 默认值 | +| ---------------------------------------------- | ------------------------------------ | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | +| image-manager.file.root | `string[]` | 扫描图片的根目录 | 当前工作区 | +| image-manager.file.exclude | `string[]` | 排除目录 | `['**/node_modules/**','**/.git/**',`
`'**/dist/**','**/coverage/**','**/.next/**',`
`'**/.nuxt/**','**/.vercel/**']` | +| image-manager.file.scan | `string[]` | 扫描的图片类型 | `['svg','png','jpeg','jpg',`
`'ico','gif','webp','bmp',`
`'tif','tiff','apng','avif']` | +| image-manager.file.confirmDelete | `boolean` | 删除图片时是否询问 | true | +| image-manager.file.revealFileInOsDeeply | `boolean` | 在OS中显示文件夹时进入到文件夹中 | false | +| image-manager.appearance.theme | `dark \| light \| auto` | 主题 | `auto` | +| image-manager.appearance.language | `en \| zh-CN \| zh-TW \| ja \| auto` | 语言 | `auto` | +| image-manager.appearance.primaryColor | `string` | 主题色 | undefined | +| image-manager.viewer.warningSize | `number \| boolean` | 当图片体积大于此值时右上角展示警告点（KB） | 1024 | +| image-manager.viewer.imageWidth | `number` | 图片宽度（px） | 100 | +| image-manager.viewer.imageBackgroundColor | `string` | 图片背景色 | `#1a1a1a` | +| image-manager.viewer.imageRendering | `auto \| crisp-edges \| pixelated` | 图片渲染方式（可自行调整像素风） | `auto` | +| image-manager.mirror.enabled | `boolean` | 使用镜像下载依赖 | false | +| image-manager.mirror.url | `string` | 镜像地址（通常情况不需要自定义） | undefined | +| image-manager.compression.errorRange | `number` | 误差范围（KB），超出此误差视为图片压缩后增大 | 2 | +| image-manager.compression.keepOriginal | `boolean` | 压缩后保留原图 | false | +| image-manager.compression.fileSuffix | `string` | 压缩图片文件名添加后缀 | `.min` | +| image-manager.compression.skipCompressed | `boolean` | 跳过已压缩的图片 | true | +| image-manager.compression.quality | `number` | 压缩图片质量 | - | +| image-manager.compression.size | `number` | 图片尺寸（几倍图） | 1 | +| image-manager.compression.format | `string` | 压缩时转化图片的格式 | '' | +| image-manager.compression.png.compressionLevel | `number` | png图片压缩等级 | 9 | +| image-manager.compression.gif.colors | `number` | gif图片色彩 | 256 | +| image-manager.compression.svg.\* | `svgo 配置` | 压缩svg的配置，具体配置项功能请参考svgo官方文档 | - | +| image-manager.conversion.format | `string` | 转化图片格式 | '' | +| image-manager.conversion.keepOriginal | `boolean` | 转化图片格式后保留原图 | false | +| image-manager.conversion.icoSize | `number[]` | ico图标尺寸 | [16, 32] | +| image-manager.similarity.precision | `number` | 判断图片相似的精确度。值越小，判断越严格 | 10 | diff --git a/package.json b/package.json index 9095a173..86b0a7f6 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "name": "image-manager", "version": "2.2.3", "private": true, - "description": "Compress, crop, convert format, search and find similary images in VS Code | 压缩、裁剪、转换格式、搜索、查找相似图片的 VS Code 插件", + "description": "View, compress, crop, convert format, search and find similary images in VS Code | 浏览、压缩、裁剪、转换格式、搜索、查找相似图片的 VS Code 插件", "type": "commonjs", "keywords": [ "image",