From b1fb31d655ff394cac297a9f54e25692120d7509 Mon Sep 17 00:00:00 2001 From: Kuingsmile <96409857+Kuingsmile@users.noreply.github.com> Date: Tue, 19 Aug 2025 11:17:22 +0800 Subject: [PATCH] :pencil: Docs(custom): update readme --- .../Kuingsmile.PicList.installer.yaml | 10 +- .../Kuingsmile.PicList.locale.en-US.yaml | 2 +- .../{3.0.0 => 3.0.1}/Kuingsmile.PicList.yaml | 2 +- README.md | 309 ++++++++-------- README_cn.md | 339 ------------------ README_en.md | 338 +++++++++++++++++ 6 files changed, 500 insertions(+), 500 deletions(-) rename .winget/manifests/k/Kuingsmile/PicList/{3.0.0 => 3.0.1}/Kuingsmile.PicList.installer.yaml (60%) rename .winget/manifests/k/Kuingsmile/PicList/{3.0.0 => 3.0.1}/Kuingsmile.PicList.locale.en-US.yaml (96%) rename .winget/manifests/k/Kuingsmile/PicList/{3.0.0 => 3.0.1}/Kuingsmile.PicList.yaml (91%) delete mode 100644 README_cn.md create mode 100644 README_en.md diff --git a/.winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.installer.yaml b/.winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.installer.yaml similarity index 60% rename from .winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.installer.yaml rename to .winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.installer.yaml index 9e69f3b3..434183f5 100644 --- a/.winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.installer.yaml +++ b/.winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.installer.yaml @@ -2,14 +2,14 @@ # yaml-language-server: $schema=https://aka.ms/winget-manifest.installer.1.9.0.schema.json PackageIdentifier: Kuingsmile.PicList -PackageVersion: 3.0.0 +PackageVersion: 3.0.1 InstallerType: nullsoft Installers: - Architecture: x64 - InstallerUrl: https://github.com/Kuingsmile/PicList/releases/download/v3.0.0/PicList-Setup-3.0.0.exe - InstallerSha256: 028F10E6A96CDFf4DF7018DAE6C34357D945329FD069BFD8DFBEDE817F9B56BF + InstallerUrl: https://github.com/Kuingsmile/PicList/releases/download/v3.0.1/PicList-Setup-3.0.1.exe + InstallerSha256: E819AF4D545A344814504C77DCB539CFCD4707E6B63F1FB26C3D365EAF295AC6 - Architecture: arm64 - InstallerUrl: https://github.com/Kuingsmile/PicList/releases/download/v3.0.0/PicList-Setup-3.0.0-arm64.exe - InstallerSha256: 04474E68B3A0806B7B5CC4650D42DC9B1A5086528ED45AD6520458B0B4371287 + InstallerUrl: https://github.com/Kuingsmile/PicList/releases/download/v3.0.1/PicList-Setup-3.0.1-arm64.exe + InstallerSha256: 0F5001AFD90898CA5477A6CAED5D76A4A6EE89FB9EF6309ACA83298A992A512A ManifestType: installer ManifestVersion: 1.9.0 diff --git a/.winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.locale.en-US.yaml b/.winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.locale.en-US.yaml similarity index 96% rename from .winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.locale.en-US.yaml rename to .winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.locale.en-US.yaml index 91fac396..5ad8b964 100644 --- a/.winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.locale.en-US.yaml +++ b/.winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.locale.en-US.yaml @@ -2,7 +2,7 @@ # yaml-language-server: $schema=https://aka.ms/winget-manifest.defaultLocale.1.9.0.schema.json PackageIdentifier: Kuingsmile.PicList -PackageVersion: 3.0.0 +PackageVersion: 3.0.1 PackageLocale: en-US Publisher: Kuingsmile PublisherUrl: https://github.com/Kuingsmile diff --git a/.winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.yaml b/.winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.yaml similarity index 91% rename from .winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.yaml rename to .winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.yaml index 231a720a..36b55f11 100644 --- a/.winget/manifests/k/Kuingsmile/PicList/3.0.0/Kuingsmile.PicList.yaml +++ b/.winget/manifests/k/Kuingsmile/PicList/3.0.1/Kuingsmile.PicList.yaml @@ -2,7 +2,7 @@ # yaml-language-server: $schema=https://aka.ms/winget-manifest.version.1.9.0.schema.json PackageIdentifier: Kuingsmile.PicList -PackageVersion: 3.0.0 +PackageVersion: 3.0.1 DefaultLocale: en-US ManifestType: version ManifestVersion: 1.9.0 diff --git a/README.md b/README.md index a06a06d9..2ecc1264 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
- + -[简体中文](https://github.com/Kuingsmile/PicList/blob/dev/README_cn.md) | English +简体中文 | [English](https://github.com/Kuingsmile/PicList/blob/dev/README_en.md) -## 📑 Table of Contents +## 📑 目录 -- [📑 Table of Contents](#-table-of-contents) -- [Introduction](#introduction) -- [Official Website](#official-website) -- [How to Migrate from PicGo](#how-to-migrate-from-picgo) +- [📑 目录](#-目录) +- [简介](#简介) +- [官方网址](#官方网址) +- [如何从PicGo迁移](#如何从picgo迁移) - [PicList-Core](#piclist-core) -- [Key Features](#key-features) -- [Integration Guides](#integration-guides) - - [VSCode Integration](#vscode-integration) - - [Typora Integration](#typora-integration) - - [**Version 1.6.0-dev and above**](#version-160-dev-and-above) - - [**Version \< 1.6.0-dev**](#version--160-dev) - - [Obsidian Integration](#obsidian-integration) - - [Docker Integration](#docker-integration) - - [Using docker run](#using-docker-run) - - [Using docker-compose](#using-docker-compose) -- [Supported Platforms](#supported-platforms) -- [Download and Install](#download-and-install) - - [Direct Download](#direct-download) - - [Scoop (Windows)](#scoop-windows) +- [特色功能](#特色功能) +- [如何使用](#如何使用) + - [如何在VSCode中使用](#如何在vscode中使用) + - [如何在Typora中使用](#如何在typora中使用) + - [**1.6.0版本及以上**](#160版本及以上) + - [**1.6.0版本以下**](#160版本以下) + - [如何在Obsidian中使用](#如何在obsidian中使用) + - [如何在Docker中使用](#如何在docker中使用) + - [使用docker run命令](#使用docker-run命令) + - [使用docker-compose](#使用docker-compose) +- [已支持平台](#已支持平台) +- [下载安装](#下载安装) + - [直接下载](#直接下载) + - [Scoop(Windows)](#scoopwindows) - [Winget (Windows)](#winget-windows) - - [Homebrew (macOS)](#homebrew-macos) - - [OS Requirements](#os-requirements) + - [Homebrew(macOS)](#homebrewmacos) + - [系统版本要求](#系统版本要求) - [Windows](#windows) - [macOS](#macos) - [Linux](#linux) -- [Screenshots](#screenshots) -- [Development](#development) - - [Prerequisites](#prerequisites) - - [Getting Started](#getting-started) - - [Development Mode](#development-mode) - - [Production Build](#production-build) -- [Related Projects](#related-projects) -- [Community](#community) +- [应用截图](#应用截图) +- [开发说明](#开发说明) + - [前提条件](#前提条件) + - [开始开发](#开始开发) + - [开发模式](#开发模式) + - [生产构建](#生产构建) +- [其它相关](#其它相关) +- [交流群](#交流群) - [License](#license) - [Star Me](#star-me) -## Introduction +## 简介 -PicList is an efficient cloud storage and image hosting management tool built upon PicGo with extensive enhancements. It combines complete image hosting capabilities with comprehensive cloud storage management features, offering: +PicList是一款高效的云存储和图床平台管理工具,基于PicGo深度二次开发,提供完整的图床功能和全面的云存储管理能力,主要特点包括: -- All original PicGo functionality plus compatibility with most PicGo plugins -- Extended built-in image hosting platforms (WebDav, local hosting, SFTP, etc.) -- Cloud-synchronized file deletion in album view -- Comprehensive cloud storage management with file operations, search, and previews -- Built-in image processing tools (watermarks, compression, scaling, rotation, format conversion) +- 完整保留PicGo所有功能,兼容大部分PicGo插件 +- 扩展了内置图床平台,如WebDav、本地图床和SFTP等 +- 相册支持同步云端删除文件 +- 全面的云存储管理功能,包括文件操作、搜索和预览 +- 内置图像处理工具,如水印、压缩、缩放、旋转和格式转换 -## Official Website +## 官方网址 -Please visit the [PicList official website piclist.cn](https://piclist.cn) for more information. +请访问 [PicList官网 piclist.cn](https://piclist.cn) 获取更多信息。 -You can also visit the [DeepWiki of PicList](https://deepwiki.com/Kuingsmile/PicList) to learn more about the project architecture and development. +此外,你也可以访问[DeepWiki of PicList](https://deepwiki.com/Kuingsmile/PicList)了解更多关于项目架构和开发的内容。 -## How to Migrate from PicGo +## 如何从PicGo迁移 -PicList `V1.5.0` and above provide a `one-click migration` function. Enter the `Settings` page, click the button next to `Migrate from PicGo`, then restart the application for changes to take effect. +PicList `V1.5.0`以上版本提供 `一键迁移`功能,进入 `设置`页面,然后在 `从PicGo迁移`选项点击右侧按钮即可,迁移后请重启应用生效。 ## PicList-Core -PicList uses a modified version of PicGo-Core called [PicList-core](https://github.com/Kuingsmile/PicList-Core), adapted for cloud deletion and extended with features like: +PicList的内核使用[PicList-core](https://github.com/Kuingsmile/PicList-Core),这是基于原版PicGo-Core修改的版本,具有以下增强功能: -- Watermark addition -- Image compression, scaling, rotation, and format conversion -- CLI command support -- Built-in upload server via `picgo-server` command +- 水印添加 +- 图片压缩、缩放、旋转和格式转换 +- CLI命令行支持 +- 通过`picgo-server`命令启动上传服务器 -To use PicList-core separately, visit [GitHub repo](https://github.com/Kuingsmile/PicList-Core) or the [npm package](https://www.npmjs.com/package/piclist). +如果您希望单独使用PicList-core,请访问[GitHub仓库](https://github.com/Kuingsmile/PicList-Core)或[npm包](https://www.npmjs.com/package/piclist)。 -## Key Features +## 特色功能 -- **Complete Compatibility**: Works with Typora, Obsidian, and most PicGo plugins -- **Extended Platform Support**: Added WebDav, Lsky Pro, local hosting, SFTP, and account-based Imgur uploads -- **Cloud-Sync Album**: Delete images from storage alongside local entries -- **Advanced Album Features**: Search, sort, and batch URL modification -- **Built-in Image Tools**: Add watermarks, compress, scale, rotate, and convert formats -- **Form Upload**: Share across multiple computers -- **Config Synchronization**: Save settings to GitHub/Gitee/Gitea repositories -- **Cloud Management**: Browse directories, search files, batch operations, and more -- **Multi-format Previews**: View images, videos, text files, and Markdown files (see [supported formats](https://github.com/Kuingsmile/PicList/blob/dev/supported_format.md)) -- **Batch Operations**: Rename cloud files with regular expressions -- **Link Sharing**: Generate pre-signed URLs for private storage buckets -- **Usability Improvements**: Auto-updates, multiple startup modes, UI enhancements, and more +- **完全兼容性**:适用于Typora、Obsidian和大多数PicGo插件 +- **扩展平台支持**:新增WebDav、兰空图床、本地图床、SFTP等,原内置imgur图床额外支持账号登录上传 +- **云端同步相册**:支持同步删除云端图片,兼容所有内置图床和多个插件 +- **高级相册功能**:高级搜索、排序和批量URL修改 +- **内置图像工具**:水印添加、图片压缩、图片缩放、图片旋转和格式转换,支持高级重命名 +- **表单上传**:支持多电脑共享使用 +- **配置同步**:支持配置同步至GitHub/Gitee/Gitea仓库 +- **云存储管理**:云端目录查看、文件搜索、批量操作等功能 +- **多格式预览**:支持预览图片、视频、文本和Markdown文件(查看[支持的文件格式列表](https://github.com/Kuingsmile/PicList/blob/dev/supported_format.md)) +- **批量操作**:支持使用正则表达式批量重命名云端文件 +- **链接分享**:为私有存储桶生成预签名链接 +- **易用性改进**:软件自动更新、多种启动模式、界面优化等 -## Integration Guides +## 如何使用 -### VSCode Integration +### 如何在VSCode中使用 -Install the [VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist) plugin, which integrates directly with PicList desktop software and supports a variety of uploads and cloud deletion operations in VSCode. +安装[VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist)插件,与vs-picgo插件相比,该插件直接依赖于PicList桌面端软件,支持多种上传方式和直接在VSCode中进行云端删除等功能。 -### Typora Integration +### 如何在Typora中使用 -#### **Version 1.6.0-dev and above** +#### **1.6.0版本及以上** -**Typora 1.6.0-dev and later versions natively support PicList.** For versions below 1.10.6, set Typora's language to Chinese. +**Typora 1.6.0-dev以及以上版本已原生支持PicList**。在1.10.6版本以下中,需要将Typora的语言设置为中文。 -If your Typora version is below 1.8.0, set both the PicList and PicGo (app) upload service paths to your PicList installation path. +如果您使用的是1.8.0以下版本的Typora,需要同时设置PicList和PicGo(app)上传服务的路径为PicList的安装路径。 -[Typora download link](https://typora.io/releases/all) +[Typora下载链接](https://typora.io/releases/all) -#### **Version < 1.6.0-dev** +#### **1.6.0版本以下** -For Windows, in Typora settings: +Windows系统: -1. Set upload service to `PicGo(app)` -2. Set `PicGo path` to your PicList installation path +1. 进入Typora设置页面,选择"图像" +2. 将上传服务设置为`PicGo(app)` +3. 在`PicGo路径`中填写PicList的安装路径 - + -Alternatively, install PicList-core with `npm install piclist` and set the upload service to `PicGo-Core (command line)`. +或者,您也可以使用`npm install piclist`命令安装PicList-core,然后将上传服务设置为`PicGo-Core(command line)`。 -### Obsidian Integration +### 如何在Obsidian中使用 -1. Install the "Image auto upload Plugin" from community plugins -2. Set the default uploader to PicGo(app) -3. Configure PicGo server as `http://127.0.0.1:36677/upload` -4. For cloud deletion support, set the deletion interface to `http://127.0.0.1:36677/delete` +1. 在社区插件中搜索安装`Image auto upload Plugin` +2. 进入插件设置页面,将默认上传器修改为`PicGo(app)` +3. 设置`PicGo server`为`http://127.0.0.1:36677/upload` +4. 如需启用云端删除功能,请在删除接口中填入`http://127.0.0.1:36677/delete` - + -### Docker Integration +### 如何在Docker中使用 -#### Using docker run +#### 使用docker run命令 ```bash docker pull kuingsmile/piclist:latest @@ -152,9 +153,9 @@ docker run -d \ node /usr/local/bin/picgo-server -k piclist123456 ``` -Change `./piclist` to your config directory path and `piclist123456` to your preferred secret key. +请将`./piclist`修改为您的配置文件`config.json`所在路径,将`piclist123456`修改为您自己的密钥。 -#### Using docker-compose +#### 使用docker-compose ```yaml version: '3.3' @@ -171,43 +172,43 @@ services: command: node /usr/local/bin/picgo-server -k piclist123456 ``` -Run with `docker-compose up -d` +使用`docker-compose up -d`命令启动。 -## Supported Platforms +## 已支持平台 -| Platform | Album Cloud Deletion | Cloud Storage Management | -| :------------------------: | :------------------: | :----------------------: | -| Built-in AList | ✔️ | ✔️ | -| SM.MS | ✔️ | ✔️ | -| Github | ✔️ | ✔️ | -| Imgur | ✔️ | ✔️ | -| Tencent COS V5 | ✔️ | ✔️ | -| Aliyun OSS | ✔️ | ✔️ | -| Upyun | ✔️ | ✔️ | -| Qiniu | ✔️ | ✔️ | -| S3 API compatible platform | ✔️ | ✔️ | -| WebDAV | ✔️ | ✔️ | -| Local | ✔️ | ✔️ | -| Built-in SFTP | ✔️ | ✔️ | -| Doge Cloud | ✔️ | ✔️ | -| PicList(Lasso-Doll) | ✔️ | ✔️ | -| Lsky Pro | ✔️ | ✔️ | -| Custom API platform | × | × | +| 平台 | 相册云删除 | 云存储管理 | +| :------------: | :--------: | :--------: | +| 内置AList | ✔️ | ✔️ | +| SM.MS | ✔️ | ✔️ | +| Github | ✔️ | ✔️ | +| Imgur | ✔️ | ✔️ | +| 腾讯COS V5 | ✔️ | ✔️ | +| 阿里云OSS | ✔️ | ✔️ | +| 又拍云 | ✔️ | ✔️ | +| 七牛云 | ✔️ | ✔️ | +| S3 API兼容平台 | ✔️ | ✔️ | +| WebDAV | ✔️ | ✔️ | +| 本地文件夹 | ✔️ | ✔️ | +| 内置SFTP | ✔️ | ✔️ | +| 多吉云 | ✔️ | ✔️ | +| PicList(套娃) | ✔️ | ✔️ | +| 兰空图床 | ✔️ | ✔️ | +| 自定义图床 | x | x | -**Supported Plugins with Cloud Deletion:** +**支持云删除功能的插件:** - [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) - [picgo-plugin-alist](https://github.com/jinzhi0123/picgo-plugin-alist) - [picgo-plugin-huawei-uploader](https://github.com/YunfengGao/picgo-plugin-huawei-uploader) - [picgo-plugin-dogecloud](https://github.com/w4j1e/picgo-plugin-dogecloud) -## Download and Install +## 下载安装 -### Direct Download +### 直接下载 -[Download the latest release](https://github.com/Kuingsmile/PicList/releases/latest) +[下载最新版本](https://github.com/Kuingsmile/PicList/releases/latest) -### Scoop (Windows) +### Scoop(Windows) ```bash scoop bucket add lemon https://github.com/hoilc/scoop-lemon @@ -220,81 +221,81 @@ scoop install lemon/piclist winget install Kuingsmile.PicList ``` -### Homebrew (macOS) +### Homebrew(macOS) ```bash -# Install +# 安装 brew install piclist --cask -# Uninstall +# 卸载 brew uninstall piclist ``` -### OS Requirements +### 系统版本要求 #### Windows -- **Supported Versions**: Windows 10 and later -- **Architectures**: `ia32` (x86), `x64` (amd64), `arm64` +- **支持的版本**: Windows 10及以上版本 +- **架构**: `ia32` (x86), `x64` (amd64), `arm64` #### macOS -- **Supported Versions**: macOS Big Sur (11) and later -- **Architectures**: Intel (x64) and Apple Silicon (arm64) +- **支持的版本**: macOS Big Sur (11)及以上 +- **架构**: Intel (x64)和Apple Silicon (arm64) #### Linux -- **Supported Versions**: - - Ubuntu 18.04 and later - - Fedora 32 and later - - Debian 10 and later +- **包括不限于**: + - Ubuntu 18.04及更新版本 + - Fedora 32及更新版本 + - Debian 10及更新版本 -## Screenshots +## 应用截图 - - - - - - + + + + + + -## Development +## 开发说明 -### Prerequisites +### 前提条件 -1. Node.js 20 + and Git -2. Knowledge of npm -3. Xcode for Mac or Visual Studio for Windows +1. 需要Node.js 20+ 和 Git +2. 了解npm相关知识 +3. Mac需要Xcode环境,Windows需要Visual Studio环境 -### Getting Started +### 开始开发 ```bash git clone https://github.com/Kuingsmile/PicList.git cd PicList -yarn # Do not use npm install +yarn # 不要使用npm install ``` -To contribute, see the [contribution guide](https://github.com/Kuingsmile/PicList/blob/dev/CONTRIBUTING_EN.md). +如需贡献代码,请参考[贡献指南](https://github.com/Kuingsmile/PicList/blob/dev/CONTRIBUTING.md)。 -### Development Mode +### 开发模式 ```bash yarn run dev ``` -Development mode has hot-reload but may be unstable. If the process crashes, exit with `Ctrl+C` and restart. +开发模式具有热重载特性,但可能不稳定。如果进程崩溃,请用`Ctrl+C`退出并重新启动。 -Note: The PicList application icon will appear in your taskbar/system tray while in development mode. +注意:开发模式运行后,PicList的应用图标会出现在任务栏/系统托盘中。 -### Production Build +### 生产构建 ```bash yarn run build ``` -The built installer will be available in the `dist_electron` directory. +构建成功后,安装文件将出现在`dist_electron`目录中。 -For network issues with electron-builder, set the mirror: +如果遇到网络问题导致electron-builder下载失败,可以设置镜像源: **Linux/macOS:** @@ -308,23 +309,23 @@ export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/ ``` -## Related Projects +## 其它相关 -- [PicList-Core](https://github.com/Kuingsmile/PicList-Core): Core library based on PicGo-Core for CLI and development -- [PicHoro](https://github.com/Kuingsmile/PicHoro): Mobile app companion for PicList -- [VS-PicList](https://github.com/Kuingsmile/vs-PicList/): VSCode plugin for PicList +- [PicList-Core](https://github.com/Kuingsmile/PicList-Core):基于PicGo-Core的核心库,用于CLI操作和项目开发 +- [PicHoro](https://github.com/Kuingsmile/PicHoro):配合PicList使用的手机APP +- [VS-PicList](https://github.com/Kuingsmile/vs-PicList/):配合PicList使用的VSCode插件 -## Community +## 交流群 -Join our Telegram group for questions and discussion: +如有任何问题,欢迎加入TG群进行交流: -[PicList TG Group](https://t.me/+rq8y7wsj7Pg5ZTg1) +[PicList交流群](https://t.me/+rq8y7wsj7Pg5ZTg1) - + ## License -This project is open source under the MIT license. +本项目基于MIT协议开源,欢迎大家使用和贡献代码,感谢原作者Molunerfinn的开源精神。 [MIT](https://opensource.org/licenses/MIT) diff --git a/README_cn.md b/README_cn.md deleted file mode 100644 index d6c7f24f..00000000 --- a/README_cn.md +++ /dev/null @@ -1,339 +0,0 @@ - - - - -简体中文 | [English](https://github.com/Kuingsmile/PicList/blob/dev/README.md) - -## 📑 目录 - -- [📑 目录](#-目录) -- [简介](#简介) -- [官方网址](#官方网址) -- [如何从PicGo迁移](#如何从picgo迁移) -- [PicList-Core](#piclist-core) -- [特色功能](#特色功能) -- [如何使用](#如何使用) - - [如何在VSCode中使用](#如何在vscode中使用) - - [如何在Typora中使用](#如何在typora中使用) - - [**1.6.0版本及以上**](#160版本及以上) - - [**1.6.0版本以下**](#160版本以下) - - [如何在Obsidian中使用](#如何在obsidian中使用) - - [如何在Docker中使用](#如何在docker中使用) - - [使用docker run命令](#使用docker-run命令) - - [使用docker-compose](#使用docker-compose) -- [已支持平台](#已支持平台) -- [下载安装](#下载安装) - - [直接下载](#直接下载) - - [Scoop(Windows)](#scoopwindows) - - [Winget (Windows)](#winget-windows) - - [Homebrew(macOS)](#homebrewmacos) - - [系统版本要求](#系统版本要求) - - [Windows](#windows) - - [macOS](#macos) - - [Linux](#linux) -- [应用截图](#应用截图) -- [开发说明](#开发说明) - - [前提条件](#前提条件) - - [开始开发](#开始开发) - - [开发模式](#开发模式) - - [生产构建](#生产构建) -- [其它相关](#其它相关) -- [交流群](#交流群) -- [License](#license) -- [Star Me](#star-me) - -## 简介 - -PicList是一款高效的云存储和图床平台管理工具,基于PicGo深度二次开发,提供完整的图床功能和全面的云存储管理能力,主要特点包括: - -- 完整保留PicGo所有功能,兼容大部分PicGo插件 -- 扩展了内置图床平台,如WebDav、本地图床和SFTP等 -- 相册支持同步云端删除文件 -- 全面的云存储管理功能,包括文件操作、搜索和预览 -- 内置图像处理工具,如水印、压缩、缩放、旋转和格式转换 - -## 官方网址 - -请访问 [PicList官网 piclist.cn](https://piclist.cn) 获取更多信息。 - -此外,你也可以访问[DeepWiki of PicList](https://deepwiki.com/Kuingsmile/PicList)了解更多关于项目架构和开发的内容。 - -## 如何从PicGo迁移 - -PicList `V1.5.0`以上版本提供 `一键迁移`功能,进入 `设置`页面,然后在 `从PicGo迁移`选项点击右侧按钮即可,迁移后请重启应用生效。 - -## PicList-Core - -PicList的内核使用[PicList-core](https://github.com/Kuingsmile/PicList-Core),这是基于原版PicGo-Core修改的版本,具有以下增强功能: - -- 水印添加 -- 图片压缩、缩放、旋转和格式转换 -- CLI命令行支持 -- 通过`picgo-server`命令启动上传服务器 - -如果您希望单独使用PicList-core,请访问[GitHub仓库](https://github.com/Kuingsmile/PicList-Core)或[npm包](https://www.npmjs.com/package/piclist)。 - -## 特色功能 - -- **完全兼容性**:适用于Typora、Obsidian和大多数PicGo插件 -- **扩展平台支持**:新增WebDav、兰空图床、本地图床、SFTP等,原内置imgur图床额外支持账号登录上传 -- **云端同步相册**:支持同步删除云端图片,兼容所有内置图床和多个插件 -- **高级相册功能**:高级搜索、排序和批量URL修改 -- **内置图像工具**:水印添加、图片压缩、图片缩放、图片旋转和格式转换,支持高级重命名 -- **表单上传**:支持多电脑共享使用 -- **配置同步**:支持配置同步至GitHub/Gitee/Gitea仓库 -- **云存储管理**:云端目录查看、文件搜索、批量操作等功能 -- **多格式预览**:支持预览图片、视频、文本和Markdown文件(查看[支持的文件格式列表](https://github.com/Kuingsmile/PicList/blob/dev/supported_format.md)) -- **批量操作**:支持使用正则表达式批量重命名云端文件 -- **链接分享**:为私有存储桶生成预签名链接 -- **易用性改进**:软件自动更新、多种启动模式、界面优化等 - -## 如何使用 - -### 如何在VSCode中使用 - -安装[VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist)插件,与vs-picgo插件相比,该插件直接依赖于PicList桌面端软件,支持多种上传方式和直接在VSCode中进行云端删除等功能。 - -### 如何在Typora中使用 - -#### **1.6.0版本及以上** - -**Typora 1.6.0-dev以及以上版本已原生支持PicList**。在1.10.6版本以下中,需要将Typora的语言设置为中文。 - -如果您使用的是1.8.0以下版本的Typora,需要同时设置PicList和PicGo(app)上传服务的路径为PicList的安装路径。 - -[Typora下载链接](https://typora.io/releases/all) - -#### **1.6.0版本以下** - -Windows系统: - -1. 进入Typora设置页面,选择"图像" -2. 将上传服务设置为`PicGo(app)` -3. 在`PicGo路径`中填写PicList的安装路径 - - - -或者,您也可以使用`npm install piclist`命令安装PicList-core,然后将上传服务设置为`PicGo-Core(command line)`。 - -### 如何在Obsidian中使用 - -1. 在社区插件中搜索安装`Image auto upload Plugin` -2. 进入插件设置页面,将默认上传器修改为`PicGo(app)` -3. 设置`PicGo server`为`http://127.0.0.1:36677/upload` -4. 如需启用云端删除功能,请在删除接口中填入`http://127.0.0.1:36677/delete` - - - -### 如何在Docker中使用 - -#### 使用docker run命令 - -```bash -docker pull kuingsmile/piclist:latest -docker run -d \ - --name piclist \ - --restart always \ - -p 36677:36677 \ - -v "./piclist:/root/.piclist" \ - kuingsmile/piclist:latest \ - node /usr/local/bin/picgo-server -k piclist123456 -``` - -请将`./piclist`修改为您的配置文件`config.json`所在路径,将`piclist123456`修改为您自己的密钥。 - -#### 使用docker-compose - -```yaml -version: '3.3' - -services: - node: - image: 'kuingsmile/piclist:latest' - container_name: piclist - restart: always - ports: - - 36677:36677 - volumes: - - './piclist:/root/.piclist' - command: node /usr/local/bin/picgo-server -k piclist123456 -``` - -使用`docker-compose up -d`命令启动。 - -## 已支持平台 - -| 平台 | 相册云删除 | 云存储管理 | -| :------------: | :--------: | :--------: | -| 内置AList | ✔️ | ✔️ | -| SM.MS | ✔️ | ✔️ | -| Github | ✔️ | ✔️ | -| Imgur | ✔️ | ✔️ | -| 腾讯COS V5 | ✔️ | ✔️ | -| 阿里云OSS | ✔️ | ✔️ | -| 又拍云 | ✔️ | ✔️ | -| 七牛云 | ✔️ | ✔️ | -| S3 API兼容平台 | ✔️ | ✔️ | -| WebDAV | ✔️ | ✔️ | -| 本地文件夹 | ✔️ | ✔️ | -| 内置SFTP | ✔️ | ✔️ | -| 多吉云 | ✔️ | ✔️ | -| PicList(套娃) | ✔️ | ✔️ | -| 兰空图床 | ✔️ | ✔️ | -| 自定义图床 | x | x | - -**支持云删除功能的插件:** - -- [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) -- [picgo-plugin-alist](https://github.com/jinzhi0123/picgo-plugin-alist) -- [picgo-plugin-huawei-uploader](https://github.com/YunfengGao/picgo-plugin-huawei-uploader) -- [picgo-plugin-dogecloud](https://github.com/w4j1e/picgo-plugin-dogecloud) - -## 下载安装 - -### 直接下载 - -[下载最新版本](https://github.com/Kuingsmile/PicList/releases/latest) - -### Scoop(Windows) - -```bash -scoop bucket add lemon https://github.com/hoilc/scoop-lemon -scoop install lemon/piclist -``` - -### Winget (Windows) - -```bash -winget install Kuingsmile.PicList -``` - -### Homebrew(macOS) - -```bash -# 安装 -brew install piclist --cask - -# 卸载 -brew uninstall piclist -``` - -### 系统版本要求 - -#### Windows - -- **支持的版本**: Windows 10及以上版本 -- **架构**: `ia32` (x86), `x64` (amd64), `arm64` - -#### macOS - -- **支持的版本**: macOS Big Sur (11)及以上 -- **架构**: Intel (x64)和Apple Silicon (arm64) - -#### Linux - -- **包括不限于**: - - Ubuntu 18.04及更新版本 - - Fedora 32及更新版本 - - Debian 10及更新版本 - -## 应用截图 - - - - - - - - -## 开发说明 - -### 前提条件 - -1. 需要Node.js 20+ 和 Git -2. 了解npm相关知识 -3. Mac需要Xcode环境,Windows需要Visual Studio环境 - -### 开始开发 - -```bash -git clone https://github.com/Kuingsmile/PicList.git -cd PicList -yarn # 不要使用npm install -``` - -如需贡献代码,请参考[贡献指南](https://github.com/Kuingsmile/PicList/blob/dev/CONTRIBUTING.md)。 - -### 开发模式 - -```bash -yarn run dev -``` - -开发模式具有热重载特性,但可能不稳定。如果进程崩溃,请用`Ctrl+C`退出并重新启动。 - -注意:开发模式运行后,PicList的应用图标会出现在任务栏/系统托盘中。 - -### 生产构建 - -```bash -yarn run build -``` - -构建成功后,安装文件将出现在`dist_electron`目录中。 - -如果遇到网络问题导致electron-builder下载失败,可以设置镜像源: - -**Linux/macOS:** - -```bash -export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" -``` - -**Windows:** - -```cmd -set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/ -``` - -## 其它相关 - -- [PicList-Core](https://github.com/Kuingsmile/PicList-Core):基于PicGo-Core的核心库,用于CLI操作和项目开发 -- [PicHoro](https://github.com/Kuingsmile/PicHoro):配合PicList使用的手机APP -- [VS-PicList](https://github.com/Kuingsmile/vs-PicList/):配合PicList使用的VSCode插件 - -## 交流群 - -如有任何问题,欢迎加入TG群进行交流: - -[PicList交流群](https://t.me/+rq8y7wsj7Pg5ZTg1) - - - -## License - -本项目基于MIT协议开源,欢迎大家使用和贡献代码,感谢原作者Molunerfinn的开源精神。 - -[MIT](https://opensource.org/licenses/MIT) - -Copyright (c) 2017-present Molunerfinn -Copyright (c) 2023-present Kuingsmile - -## Star Me - -[](https://github.com/kuingsmile/PicList/stargazers) - -[](https://github.com/kuingsmile/PicList/stargazers) diff --git a/README_en.md b/README_en.md new file mode 100644 index 00000000..346dc016 --- /dev/null +++ b/README_en.md @@ -0,0 +1,338 @@ + + + + +[简体中文](https://github.com/Kuingsmile/PicList/blob/dev/README.md) | English + +## 📑 Table of Contents + +- [📑 Table of Contents](#-table-of-contents) +- [Introduction](#introduction) +- [Official Website](#official-website) +- [How to Migrate from PicGo](#how-to-migrate-from-picgo) +- [PicList-Core](#piclist-core) +- [Key Features](#key-features) +- [Integration Guides](#integration-guides) + - [VSCode Integration](#vscode-integration) + - [Typora Integration](#typora-integration) + - [**Version 1.6.0-dev and above**](#version-160-dev-and-above) + - [**Version \< 1.6.0-dev**](#version--160-dev) + - [Obsidian Integration](#obsidian-integration) + - [Docker Integration](#docker-integration) + - [Using docker run](#using-docker-run) + - [Using docker-compose](#using-docker-compose) +- [Supported Platforms](#supported-platforms) +- [Download and Install](#download-and-install) + - [Direct Download](#direct-download) + - [Scoop (Windows)](#scoop-windows) + - [Winget (Windows)](#winget-windows) + - [Homebrew (macOS)](#homebrew-macos) + - [OS Requirements](#os-requirements) + - [Windows](#windows) + - [macOS](#macos) + - [Linux](#linux) +- [Screenshots](#screenshots) +- [Development](#development) + - [Prerequisites](#prerequisites) + - [Getting Started](#getting-started) + - [Development Mode](#development-mode) + - [Production Build](#production-build) +- [Related Projects](#related-projects) +- [Community](#community) +- [License](#license) +- [Star Me](#star-me) + +## Introduction + +PicList is an efficient cloud storage and image hosting management tool built upon PicGo with extensive enhancements. It combines complete image hosting capabilities with comprehensive cloud storage management features, offering: + +- All original PicGo functionality plus compatibility with most PicGo plugins +- Extended built-in image hosting platforms (WebDav, local hosting, SFTP, etc.) +- Cloud-synchronized file deletion in album view +- Comprehensive cloud storage management with file operations, search, and previews +- Built-in image processing tools (watermarks, compression, scaling, rotation, format conversion) + +## Official Website + +Please visit the [PicList official website piclist.cn](https://piclist.cn) for more information. + +You can also visit the [DeepWiki of PicList](https://deepwiki.com/Kuingsmile/PicList) to learn more about the project architecture and development. + +## How to Migrate from PicGo + +PicList `V1.5.0` and above provide a `one-click migration` function. Enter the `Settings` page, click the button next to `Migrate from PicGo`, then restart the application for changes to take effect. + +## PicList-Core + +PicList uses a modified version of PicGo-Core called [PicList-core](https://github.com/Kuingsmile/PicList-Core), adapted for cloud deletion and extended with features like: + +- Watermark addition +- Image compression, scaling, rotation, and format conversion +- CLI command support +- Built-in upload server via `picgo-server` command + +To use PicList-core separately, visit [GitHub repo](https://github.com/Kuingsmile/PicList-Core) or the [npm package](https://www.npmjs.com/package/piclist). + +## Key Features + +- **Complete Compatibility**: Works with Typora, Obsidian, and most PicGo plugins +- **Extended Platform Support**: Added WebDav, Lsky Pro, local hosting, SFTP, and account-based Imgur uploads +- **Cloud-Sync Album**: Delete images from storage alongside local entries +- **Advanced Album Features**: Search, sort, and batch URL modification +- **Built-in Image Tools**: Add watermarks, compress, scale, rotate, and convert formats +- **Form Upload**: Share across multiple computers +- **Config Synchronization**: Save settings to GitHub/Gitee/Gitea repositories +- **Cloud Management**: Browse directories, search files, batch operations, and more +- **Multi-format Previews**: View images, videos, text files, and Markdown files (see [supported formats](https://github.com/Kuingsmile/PicList/blob/dev/supported_format.md)) +- **Batch Operations**: Rename cloud files with regular expressions +- **Link Sharing**: Generate pre-signed URLs for private storage buckets +- **Usability Improvements**: Auto-updates, multiple startup modes, UI enhancements, and more + +## Integration Guides + +### VSCode Integration + +Install the [VS-PicList](https://marketplace.visualstudio.com/items?itemName=Kuingsmile.vs-piclist) plugin, which integrates directly with PicList desktop software and supports a variety of uploads and cloud deletion operations in VSCode. + +### Typora Integration + +#### **Version 1.6.0-dev and above** + +**Typora 1.6.0-dev and later versions natively support PicList.** For versions below 1.10.6, set Typora's language to Chinese. + +If your Typora version is below 1.8.0, set both the PicList and PicGo (app) upload service paths to your PicList installation path. + +[Typora download link](https://typora.io/releases/all) + +#### **Version < 1.6.0-dev** + +For Windows, in Typora settings: + +1. Set upload service to `PicGo(app)` +2. Set `PicGo path` to your PicList installation path + + + +Alternatively, install PicList-core with `npm install piclist` and set the upload service to `PicGo-Core (command line)`. + +### Obsidian Integration + +1. Install the "Image auto upload Plugin" from community plugins +2. Set the default uploader to PicGo(app) +3. Configure PicGo server as `http://127.0.0.1:36677/upload` +4. For cloud deletion support, set the deletion interface to `http://127.0.0.1:36677/delete` + + + +### Docker Integration + +#### Using docker run + +```bash +docker pull kuingsmile/piclist:latest +docker run -d \ + --name piclist \ + --restart always \ + -p 36677:36677 \ + -v "./piclist:/root/.piclist" \ + kuingsmile/piclist:latest \ + node /usr/local/bin/picgo-server -k piclist123456 +``` + +Change `./piclist` to your config directory path and `piclist123456` to your preferred secret key. + +#### Using docker-compose + +```yaml +version: '3.3' + +services: + node: + image: 'kuingsmile/piclist:latest' + container_name: piclist + restart: always + ports: + - 36677:36677 + volumes: + - './piclist:/root/.piclist' + command: node /usr/local/bin/picgo-server -k piclist123456 +``` + +Run with `docker-compose up -d` + +## Supported Platforms + +| Platform | Album Cloud Deletion | Cloud Storage Management | +| :------------------------: | :------------------: | :----------------------: | +| Built-in AList | ✔️ | ✔️ | +| SM.MS | ✔️ | ✔️ | +| Github | ✔️ | ✔️ | +| Imgur | ✔️ | ✔️ | +| Tencent COS V5 | ✔️ | ✔️ | +| Aliyun OSS | ✔️ | ✔️ | +| Upyun | ✔️ | ✔️ | +| Qiniu | ✔️ | ✔️ | +| S3 API compatible platform | ✔️ | ✔️ | +| WebDAV | ✔️ | ✔️ | +| Local | ✔️ | ✔️ | +| Built-in SFTP | ✔️ | ✔️ | +| Doge Cloud | ✔️ | ✔️ | +| PicList(Lasso-Doll) | ✔️ | ✔️ | +| Lsky Pro | ✔️ | ✔️ | +| Custom API platform | × | × | + +**Supported Plugins with Cloud Deletion:** + +- [picgo-plugin-s3](https://github.com/wayjam/picgo-plugin-s3) +- [picgo-plugin-alist](https://github.com/jinzhi0123/picgo-plugin-alist) +- [picgo-plugin-huawei-uploader](https://github.com/YunfengGao/picgo-plugin-huawei-uploader) +- [picgo-plugin-dogecloud](https://github.com/w4j1e/picgo-plugin-dogecloud) + +## Download and Install + +### Direct Download + +[Download the latest release](https://github.com/Kuingsmile/PicList/releases/latest) + +### Scoop (Windows) + +```bash +scoop bucket add lemon https://github.com/hoilc/scoop-lemon +scoop install lemon/piclist +``` + +### Winget (Windows) + +```bash +winget install Kuingsmile.PicList +``` + +### Homebrew (macOS) + +```bash +# Install +brew install piclist --cask + +# Uninstall +brew uninstall piclist +``` + +### OS Requirements + +#### Windows + +- **Supported Versions**: Windows 10 and later +- **Architectures**: `ia32` (x86), `x64` (amd64), `arm64` + +#### macOS + +- **Supported Versions**: macOS Big Sur (11) and later +- **Architectures**: Intel (x64) and Apple Silicon (arm64) + +#### Linux + +- **Supported Versions**: + - Ubuntu 18.04 and later + - Fedora 32 and later + - Debian 10 and later + +## Screenshots + + + + + + + + +## Development + +### Prerequisites + +1. Node.js 20 + and Git +2. Knowledge of npm +3. Xcode for Mac or Visual Studio for Windows + +### Getting Started + +```bash +git clone https://github.com/Kuingsmile/PicList.git +cd PicList +yarn # Do not use npm install +``` + +To contribute, see the [contribution guide](https://github.com/Kuingsmile/PicList/blob/dev/CONTRIBUTING_EN.md). + +### Development Mode + +```bash +yarn run dev +``` + +Development mode has hot-reload but may be unstable. If the process crashes, exit with `Ctrl+C` and restart. + +Note: The PicList application icon will appear in your taskbar/system tray while in development mode. + +### Production Build + +```bash +yarn run build +``` + +The built installer will be available in the `dist_electron` directory. + +For network issues with electron-builder, set the mirror: + +**Linux/macOS:** + +```bash +export ELECTRON_MIRROR="https://npmmirror.com/mirrors/electron/" +``` + +**Windows:** + +```cmd +set ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/ +``` + +## Related Projects + +- [PicList-Core](https://github.com/Kuingsmile/PicList-Core): Core library based on PicGo-Core for CLI and development +- [PicHoro](https://github.com/Kuingsmile/PicHoro): Mobile app companion for PicList +- [VS-PicList](https://github.com/Kuingsmile/vs-PicList/): VSCode plugin for PicList + +## Community + +Join our Telegram group for questions and discussion: + +[PicList TG Group](https://t.me/+rq8y7wsj7Pg5ZTg1) + + + +## License + +This project is open source under the MIT license. + +[MIT](https://opensource.org/licenses/MIT) + +Copyright (c) 2017-present Molunerfinn +Copyright (c) 2023-present Kuingsmile + +## Star Me + +[](https://github.com/kuingsmile/PicList/stargazers) + +[](https://github.com/kuingsmile/PicList/stargazers)