picgo-plugin-gitee-nutpi

v1.0.1

Published

10 months ago

picgo uploader for gitee

0High
0Medium
0Low

xu_jianguo

picgo picgo-gui-plugin picgo-plugin

picgo-plugin-gitee

一个为 PicGo 开发的 Gitee 图床插件，让图片管理更简单、更高效。

📝 项目背景

在使用 Markdown 写作时，图片管理一直是一个痛点。虽然有很多图床服务，但要么需要付费，要么不够稳定。作为国内开发者经常使用的 Gitee 平台，它提供了免费的代码托管服务，何不将其作为图床使用？

基于这个想法，我开发了这个插件，它可以：

让你直接在 PicGo 中使用 Gitee 作为图床
提供简单的配置界面
支持图片的上传和删除同步
完全免费，无需额外付费

⭐ 核心特性

🚀 一键上传：快速将图片上传至 Gitee 仓库
🔄 双向同步：支持 PicGo 中的删除操作同步到 Gitee
📁 路径管理：支持自定义存储路径，更好地组织图片
💾 提交定制：支持自定义 Git 提交信息
⚡ 秒传检测：自动检测重复文件，避免重复上传
🔒 安全可靠：使用 Gitee API Token 认证，确保安全性

🚨 使用限制

⚠️ Gitee 单文件大小限制为 1MB
🔒 需要配置 Gitee 的个人访问令牌
📡 受 Gitee API 调用频率限制
🌐 图片链接受 Gitee 平台策略影响

安装

npm install picgo-plugin-gitee

配置说明

必需配置项

| 参数名 | 描述 | 示例 | |--------|------|------| | owner | Gitee 仓库所有者用户名 | nutpi | | repo | Gitee 仓库名称 | images | | token | Gitee 个人访问令牌 | 5664xxxxxxxxxxxxx |

可选配置项

| 参数名 | 描述 | 默认值 | |--------|------|--------| | path | 图片存储路径（仓库中的目录） | 根目录 | | message | Git 提交信息 | picgo commit |

仓库配置指南

方式一：创建新仓库

mkdir resources
cd resources
git init
touch README.md
git add README.md
git commit -m "first commit"
git remote add origin your-remote-link
git push -u origin master

方式二：使用现有仓库

cd existing_git_repo
git remote add origin your-remote-link
git push -u origin master

获取 Gitee Token

登录 Gitee 账号
进入设置 -> 私人令牌
生成新令牌（建议只勾选 projects 权限）
复制生成的令牌字符串

基础配置

| 配置项 | 必填 | 说明 | 示例 | | ------- | ---- | ------------ | ----------------- | | owner | 是 | Gitee 用户名 | nutpi | | repo | 是 | 仓库名称 | images | | token | 是 | 访问令牌 | xxxxxx | | path | 否 | 存储路径 | img/blog | | message | 否 | 提交信息 | Upload by PicGo |

🔧 开发指南

环境准备

git clone https://gitee.com/nutpi/picgo-plugin-gitee.git
cd picgo-plugin-gitee
npm install

项目结构

.
├── src/
│   └── index.js          # 主程序入口
├── package.json          # 项目配置
└── README.md            # 项目文档

关键模块

register: 插件注册和初始化
handle: 图片上传处理
onRemove: 删除操作处理
getUserConfig: 配置管理

开发流程

Fork 项目
创建特性分支
提交代码
创建 Pull Request

🤝 参与贡献

欢迎所有形式的贡献，包括但不限于：

提交问题和建议
完善文档内容
提交代码改进
分享使用经验

贡献步骤

先查看 Issue 列表
如果是新问题，创建新的 Issue
Fork 项目并克隆到本地
创建新分支：git checkout -b feature/your-feature
提交改动：git commit -am 'Add some feature'
推送分支：git push origin feature/your-feature
提交 Pull Request