|
1 |
| -# vs-picgo (VSCode Plugin of PicGo) |
| 1 | +# vs-picgo |
2 | 2 |
|
3 |
| -**Guide book can also be found on [PicGo/vs-picgo](https://github.com/PicGo/vs-picgo#vs-picgo-vscode-plugin-of-picgo).** |
| 3 | +> The VSCode extension of [PicGo](https://github.com/PicGo). |
4 | 4 |
|
5 | 5 | [](https://marketplace.visualstudio.com/items?itemName=Spades.vs-picgo)
|
6 | 6 | [](https://marketplace.visualstudio.com/items?itemName=Spades.vs-picgo)
|
7 |
| -[](https://ci.appveyor.com/project/PicGo/vs-picgo) |
| 7 | +[](https://dev.azure.com/PicGo/vs-picgo/_build?definitionId=1) |
8 | 8 | [](https://github.com/PicGo/vs-picgo)
|
9 |
| - |
10 |
| -> The VSCode extension of [PicGo](https://github.com/PicGo). |
| 9 | +[](https://github.com/PicGo/bump-version) |
11 | 10 |
|
12 | 11 | ## Overview
|
13 | 12 |
|
14 |
| -`vs-picgo` is a VSCode extension for uploading images to a remote image hosting service and insert the url into current active MarkDown file. It's much more efficient than other tools. And it can give us 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), [SM.MS](https://sm.ms/), supported by [PicGo-Core](https://github.com/PicGo/PicGo-Core). |
| 13 | +`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. |
15 | 14 |
|
| 15 | +## Features |
16 | 16 |
|
17 | 17 | <details>
|
18 | 18 | <summary>Uploading an image from clipboard</summary>
|
|
30 | 30 | </details>
|
31 | 31 |
|
32 | 32 | <details>
|
33 |
| -<summary>Selection as image name</summary> |
| 33 | +<summary>Use selection text as the uploaded `fileName`</summary> |
34 | 34 | <img src="https://i.loli.net/2019/04/09/5cac180fb1dc7.gif" alt="selection.gif">
|
35 | 35 | <b>Notice: These characters: <code>\$</code>, <code>:</code>, <code>/</code>, <code>?</code> and newline will be ignored in the image name. </b>(Because they are invalid for file names.)
|
36 | 36 | </details>
|
37 | 37 |
|
| 38 | +## Keyboard shortcuts |
| 39 | + |
| 40 | +**You can change all the shortcuts below as you wish.** |
| 41 | + |
| 42 | +| OS | Uploading an image from clipboard | Uploading images from explorer | Uploading an image from input box | |
| 43 | +| ------------ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | |
| 44 | +| Windows/Unix | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>U</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>E</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>O</kbd> | |
| 45 | +| OsX | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>U</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>E</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>O</kbd> | |
38 | 46 |
|
39 | 47 | ## Settings
|
40 | 48 |
|
41 | 49 | - out of box
|
42 |
| - - We could use `vs-picgo` without any setting. |
| 50 | + - We could use `vs-picgo` without any settings. |
43 | 51 | - The default image hosting is [SM.MS](https://sm.ms/).
|
44 | 52 | - custom
|
45 | 53 |
|
|
80 | 88 |
|
81 | 89 | Suggested settings for [`PicGo-electron`](https://github.com/Molunerfinn/PicGo) users (See [PicGo configuration path](https://picgo.github.io/PicGo-Doc/zh/guide/config.html#%E9%85%8D%E7%BD%AE%E6%89%8B%E5%86%8C) for more information):
|
82 | 90 |
|
83 |
| - **Notice: `YOUR_HOME_DIR` should be replaced by the path of current user path.** |
| 91 | + <details> |
| 92 | + |
| 93 | + **Notice: `YOUR_HOME_DIR` should be replaced by the path of your current user path.** |
84 | 94 |
|
85 | 95 | ```json
|
86 | 96 | // Windows
|
|
112 | 122 | 1. `vs-picgo` will use the same configuration as `PicGo-electron`.
|
113 | 123 | 2. `PicGo-electron` will display all the uploaded images by `vs-picgo` in its gallery.
|
114 | 124 |
|
115 |
| -## Keyboard shortcuts |
116 |
| - |
117 |
| -**You can change all the shortcuts below as you wish.** |
118 |
| - |
119 |
| -| OS | Uploading an image from clipboard | Uploading images from explorer | Uploading an image from input box | |
120 |
| -| ------------ | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | |
121 |
| -| Windows/Unix | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>U</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>E</kbd> | <kbd>Ctrl</kbd> + <kbd>Alt</kbd> + <kbd>O</kbd> | |
122 |
| -| OsX | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>U</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>E</kbd> | <kbd>Cmd</kbd> + <kbd>Opt</kbd> + <kbd>O</kbd> | |
| 125 | + </details> |
123 | 126 |
|
124 | 127 | ## Migration
|
125 | 128 |
|
126 |
| -- From ^1.0.0 |
| 129 | +- From ^1.0.0 to ^2.x |
127 | 130 | - External configuration file property has changed, from `picgo.path` to `picgo.configPath`.
|
128 | 131 |
|
129 |
| -## Usage |
| 132 | +## Versioning |
| 133 | + |
| 134 | +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 [Azure](https://dev.azure.com/upupming/vs-picgo/_build?definitionId=1), and you can just open the build of a specific commit, and go to the Summary tab to download the artifacts. |
| 135 | + |
| 136 | +## Contributing |
130 | 137 |
|
131 |
| -- Find `vs-picgo` in the extension store, and install `vs-picgo`. You can use `vs-picgo` on installation finished. |
| 138 | +Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. |
132 | 139 |
|
133 | 140 | ## Contributors
|
134 | 141 |
|
|
0 commit comments