Skip to content

Commit

Permalink
fix: update readme and link to my
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisTowles committed Sep 30, 2022
1 parent 5ef5bd1 commit d26af6d
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 18 deletions.
44 changes: 31 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,34 @@
<h1 align="center">Markdown Paste image <sup>VS Code</sup></h1>

<p align="center">
<!--
<a href="https://marketplace.visualstudio.com/items?itemName=antfu.smart-clicks" target="__blank"><img src="https://img.shields.io/visual-studio-marketplace/v/antfu.smart-clicks.svg?color=eee&amp;label=VS%20Code%20Marketplace&logo=visual-studio-code" alt="Visual Studio Marketplace Version" /></a>
-->

<a href="https://marketplace.visualstudio.com/items?itemName=chris-towles.markdown-paste-image" target="__blank">
<img src="https://img.shields.io/visual-studio-marketplace/v/chris-towles.markdown-paste-image.svg?color=eee&amp;label=VS%20Code%20Marketplace&logo=visual-studio-code" alt="Visual Studio Marketplace Version" /></a>

</p>

<p align="center">
Paste Image from clipboard into markdown for VS Code.<br>
Paste an Image from clipboard into markdown for VS Code<br>

</p>

<img src="https://raw.githubusercontent.com/ChrisTowles/vscode-markdown-paste-image/main/res/markdown-paste-image-preview.gif" height="150">
<img src="https://raw.githubusercontent.com/ChrisTowles/vscode-markdown-paste-image/main/res/markdown-paste-image-preview.gif" width="600">

## Installation

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

```bash
ext install chris-towles.markdown-paste-image
```

## Features

- Paste image from clipboard into markdown
- prompts for the file name or uses the selected text as the file name.
- Save clipboard image as `PNG` file and insert image markdown.

There are other plugins that had this feature, but they were not maintained, had bugs, or had tons of features I didn't want. So here is a simple extension that does one thing and one thing only and does it with [tests](https://github.com/ChrisTowles/vscode-markdown-paste-image/actions)!

## Requirements

Expand All @@ -26,28 +44,28 @@ Paste Image from clipboard into markdown for VS Code.<br>

`// TODO`

## Rules

## Configuration

All the rules are enabled by default. To disable a specific rule, set the rule to `false` in `smartClicks.rules` of your VS Code settings:

Time format is configured with [Luxon](https://moment.github.io/luxon/#/formatting?id=table-of-tokens)

```jsonc
// settings.json

// TODO!

```

## VsCode Docs
## VsCode Publish

- <https://code.visualstudio.com/api/references/activation-events>
- [Micrsoft Publisher UI](https://marketplace.visualstudio.com/manage/publishers/)
- [VsCode API Docs](https://code.visualstudio.com/api/references/activation-events)
-

## Credits

I wanted to make this plugin after issues with markdown image paste [mushan.vscode-paste-image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image). After looking for an alternative and finding out that it looked like there were half a [dozen copies](https://marketplace.visualstudio.com/search?term=image%20paste%20markdown&target=VSCode&category=Other&sortBy=Relevance) and most forks and longer maintained.
I wanted to make this plugin after issues with markdown image paste [mushan.vscode-paste-image](https://marketplace.visualstudio.com/items?itemName=mushan.vscode-paste-image). After looking for an alternative and finding out that it looked like there were half a [dozen copies](https://marketplace.visualstudio.com/search?term=image%20paste%20markdown&target=VSCode&category=Other&sortBy=Relevance) and most were forks, or no longer maintained.

I decided to use [Anthony Fu](https://github.com/antfu)'s repo for [vscode-smart-clicks](https://github.com/antfu/vscode-smart-clicks) as a starting point. And then refactor to have the features that I wanted.
I decided to use [Anthony Fu](https://github.com/antfu)'s repo for [vscode-smart-clicks](https://github.com/antfu/vscode-smart-clicks) as a starting point. And then build from there to have the features that I wanted.

## License

Expand Down
6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"publisher": "ChrisTowles",
"publisher": "chris-towles",
"name": "markdown-paste-image",
"displayName": "Markdown Paste Image",
"version": "0.0.1",
Expand Down Expand Up @@ -130,9 +130,6 @@
"typecheck": "tsc --noEmit",
"release": "bumpp --commit --push --tag && nr publish"
},
"dependencies": {
"cross-env": "^7.0.3"
},
"devDependencies": {
"@antfu/eslint-config": "^0.25.2",
"@antfu/ni": "^0.16.3",
Expand All @@ -148,6 +145,7 @@
"@vitest/ui": "^0.23.4",
"@vscode/test-electron": "^2.1.5",
"bumpp": "^8.2.1",
"cross-env": "^7.0.3",
"eslint": "^8.19.0",
"esno": "^0.16.3",
"fast-glob": "^3.2.11",
Expand Down
1 change: 0 additions & 1 deletion playground/folder-test/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,4 @@ Paste an Image you have in your clipboard!

It will prompt you for a file name and then save it to the folder you are in.


Also select text to use that as the image file name.

0 comments on commit d26af6d

Please sign in to comment.