Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PicGo/vs-picgo
A VSCode plugin of PicGo
https://github.com/PicGo/vs-picgo
image-upload picgo picgo-plugin vs-picgo vscode-extension writing
Last synced: about 2 months ago
JSON representation
A VSCode plugin of PicGo
- Host: GitHub
- URL: https://github.com/PicGo/vs-picgo
- Owner: PicGo
- License: mit
- Created: 2018-09-24T15:29:21.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2023-01-07T06:00:21.000Z (about 2 years ago)
- Last Synced: 2024-05-19T02:08:21.775Z (8 months ago)
- Topics: image-upload, picgo, picgo-plugin, vs-picgo, vscode-extension, writing
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=Spades.vs-picgo
- Size: 2.39 MB
- Stars: 366
- Watchers: 11
- Forks: 48
- Open Issues: 32
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-PicGo - vs-picgo
README
# vs-picgo
> The VSCode extension of [PicGo](https://github.com/PicGo).
[](https://marketplace.visualstudio.com/items?itemName=Spades.vs-picgo)
[](https://marketplace.visualstudio.com/items?itemName=Spades.vs-picgo)
[](https://actions-badge.atrox.dev/PicGo/vs-picgo/goto?ref=dev)
[](https://coveralls.io/github/PicGo/vs-picgo?branch=refs/heads/dev)
[](https://github.com/PicGo/vs-picgo)
[](https://github.com/PicGo/bump-version)
[](https://standardjs.com)
## Overview
`vs-picgo` is a VSCode extension for uploading images to a remote image hosting service and insert the url into the current editing file. It's much more efficient than other tools. And it can give us the better experience of uploading images. `vs-picgo` supports 8 kinds of image hosting services: [weibo](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E5%BE%AE%E5%8D%9A%E5%9B%BE%E5%BA%8A), [qiniu](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E4%B8%83%E7%89%9B%E5%9B%BE%E5%BA%8A), [tcyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E8%85%BE%E8%AE%AF%E4%BA%91cos), [upyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E5%8F%88%E6%8B%8D%E4%BA%91), [github](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#github%E5%9B%BE%E5%BA%8A), [aliyun](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E9%98%BF%E9%87%8C%E4%BA%91oss), [imgur](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#imgur%E5%9B%BE%E5%BA%8A) and [SM.MS](https://sm.ms/), which are supported by [PicGo-Core](https://github.com/PicGo/PicGo-Core). And the plugin feature of PicGo-Core is working in progress.
## Features
Uploading an image from clipboard
Uploading images from explorer
Uploading images from input box
Use selection text as the uploaded fileName
Notice: These characters: \$, :, /, ? and newline will be ignored in the image name. (Because they are invalid for file names.)
## Keyboard shortcuts
**You can change all the shortcuts below as you wish.**
| OS | Uploading an image from clipboard | Uploading images from explorer | Uploading an image from input box |
| ------------ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- |
| Windows/Unix | Ctrl + Alt + U | Ctrl + Alt + E | Ctrl + Alt + O |
| OsX | Cmd + Opt + U | Cmd + Opt + E | Cmd + Opt + O |
## Settings
- Default
- The default image hosting is [SM.MS](https://sm.ms/).
- Custom
BIG NEWS: from 2.0.0, We can customize the settings in VSCode settings
- Use an external configuration file
Enter the path of the configuration file
- Use VSCode settings
First, choose the current PicBed
Then, input all the info the current PicBed needs
Customize the name of the image to be uploaded
Notice: If you selected some text before uploading, the selection will become the fileName of the image to be uploaded.
Customize the output format of the uploaded image
Suggested settings for PicGo-electron users (See PicGo configuration path for more information):
**Notice: `YOUR_HOME_DIR` should be replaced by the path of your current user path.**
```json
// Windows
{
"picgo.configPath":"YOUR_HOME_DIR\\AppData\\Roaming\\PicGo\\data.json",
"picgo.dataPath": "YOUR_HOME_DIR\\AppData\\Roaming\\PicGo\\data.json"
}
// macOS
{
"picgo.configPath": "YOUR_HOME_DIR/Library/Application Support/picgo/data.json",
"picgo.dataPath": "YOUR_HOME_DIR/Library/Application Support/picgo/data.json"
}
// Linux
{
"picgo.configPath": "YOUR_HOME_DIR/.config/picgo/data.json",
"picgo.dataPath": "YOUR_HOME_DIR/.config/picgo/data.json"
}
```
picgo.configPath and picgo.dataInfoPath can be set in vscode settings
In this way:
1. `vs-picgo` will use the same configuration as `PicGo-electron`.
2. `PicGo-electron` will display all the uploaded images by `vs-picgo` in its gallery.
## Migration
- From ^1.0.0 to ^2.x
- External configuration file property has changed, from `picgo.path` to `picgo.configPath`.
## Versioning
For the versions available, see the [tags on PicGo/vs-picgo](https://github.com/PicGo/vs-picgo/tags). ChangeLogs can be found at [CHANGELOG.md](CHANGELOG.md). All the dev builds can be found on [GitHub Actions](https://github.com/PicGo/vs-picgo/actions/), and you can just open the build of a specific commit, and go to the Summary tab to download the artifacts.
## Contributing
Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
## Contributors
- [Spades-S](https://github.com/Spades-S)
- [Molunerfinn](https://github.com/Molunerfinn)
- [upupming](https://github.com/upupming)
## Thanks
- [PicGo-Core](https://github.com/PicGo/PicGo-Core)
**Enjoy!**