English Readme / 简体中文说明 / 繁體中文說明

Markdown Image

An extension for conveniently inserting pictures in Markdown, which supports storing pictures in local or third-party CDN service.

❤ Sponsor me / 赞助开发者

Features

Copy image files or paste screenshots, Shortcut key Ctrl + Shift + V, or right-click menu Paste Image.
Automatically generate Markdown code insertion.
Configurable to support Imgur, Qiniu, SM.MS, Coding, Cloudinary and other CDN service. The default is local, you need to open the folder where the Markdown file is located.
You can also customize the code to upload pictures.
Support Windows, MacOS, Linux.

Requirements

Linux users must install xclip.

Ubuntu

sudo apt install xclip

CentOS

sudo yum install epel-release.noarch
sudo yum install xclip

Extension Settings

Base Settings

markdown-image.base.uploadMethod: Method to upload pictures. To the local or another picture CDN service.
markdown-image.base.fileNameFormat: The filename format for upload. Not Support in Imgur and SM.MS. You can use some variables. You can find more in setting.

Local Settings

markdown-image.local.path: Picture storage directory that in the local (automatically created if it does not exist).

Coding Settings

markdown-image.coding.token: Coding person access token.
markdown-image.coding.repository: Coding repository, for example: https://coding-demo.coding.net/p/coding-demo/d/coding-demo/git
markdown-image.coding.path: Picture upload directory that in the repository (automatically created if it does not exist).

Imgur Settings

markdown-image.imgur.clientId: The client id registered with imgur. You can registed it at here.
markdown-image.imgur.httpProxy: Connect to Imgur via http proxy.

SM.MS Settings

markdown-image.sm_ms.token: SM.MS API token (Options). You can register an account and then visit API Token Page to generate secret token.

Qiniu Settings

markdown-image.qiniu.accessKey: The Access Key of account。
markdown-image.qiniu.secretKey: The Secret Key of account。
markdown-image.qiniu.bucket: The storage name。
markdown-image.qiniu.domain: Bound domain name of storage。
markdown-image.qiniu.zone: Zone of storage.

Cloudinary Settings

These values can be found on your Cloudinary Dashboard

markdown-image.cloudinary.cloudName: Your user account name.
markdown-image.cloudinary.apiKey: API key for your account.
markdown-image.cloudinary.apiSecret: API secret for your account.
markdown-image.cloudinary.folder: Folder to upload the image to.

DIY Settings

markdown-image.DIY.path: The Code Path what you write. Your code must exports a function as async function (filePath:string, savePath:string, markdownPath:string):string. For example:

const path = require('path');
module.exports = async function(filePath, savePath, markdownPath) {
    // Return a picture access link
    return path.relative(path.dirname(markdownPath), filePath);
}

Release Notes

1.1.14

Update Coding Picbed Package to fixed upload to coding error.

1.1.13

Added new setting markdown-image.local.referencePath to support DIY reference path in markdown file.

1.1.12

Added to support paste image in Jupyter file.

1.1.11

Updated Cloudinary CDN to use the markdown-image.base.fileNameFormat setting. The extension will check for existing files and will prompt to overwrite if necessary.

1.1.10

Added support for Cloudinary CDN
Includes the following new settings:
- markdown-image.cloudinary.cloudName
- markdown-image.cloudinary.apiKey
- markdown-image.cloudinary.apiSecret
- markdown-image.cloudinary.folder

1.1.9

Added setting options markdown-image.base.codeType and markdown-image.base.imageWidth use to set the maximum image width.

1.1.8

Fixed vscode caches the DIY path code, causing a question that cannot be changed immediately.

1.1.7

Added a option to switch whether url encode.

1.1.6

Fixed extension log level.
Update action after replace file.

1.1.5

Fixed Data URL Setting Description.

1.1.4

Added upload method Data URL.
Fixed paste multiple documents invalid.

1.1.3

Fixed the filename format variable ${path} were uploaded to the Coding failure in the Windows.

1.1.2

Fixed the path contains Chinese prompts cannot be found when pasting the copied picture again. 😂

1.1.1

Fixed the path contains Chinese prompts cannot be found when pasting the copied picture.

1.1.0

Added Beta feature, support paste rich text. (Only supports Windows)

1.0.14

Fixed incompatibility with Windows 7.

1.0.13

Fixed getting the path resolution error of the clipboard picture in Windows.

1.0.12

Added file name variable ${path}: "The path of the Markdown file being edited relative to the root directory."

1.0.11

Fix api url of sm.ms.
Fixed the file name with spaces cannot be found in Linux.
Added prompt without token in sm.ms.

1.0.10

Fix the variable $mdname does not remove the extension name of md.

1.0.9

Fixed the problem of getting wrong date and hour in filename formatting.

1.0.8

Add mdx support.

1.0.7

Fixed launch extension home page failed at MacOS and Linux.
Fixed the colon of the picture address is incorrectly encode.

1.0.6

Fixed the date variable has not consider the time zone.

1.0.5

Fixed file name include space could not preview.
Fixed random variable not work.

1.0.4

Update sponsored links.

1.0.3

Add sponsored links.

1.0.2

Fixed replace notice bug.

1.0.1

Update Readme.

1.0.0

Initial release.

Others

GitHub
VSCode Market
Icons made by Good Ware from www.flaticon.com

Enjoy!