Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mvdkwast authored and mvdkwast committed Nov 18, 2022
1 parent deb6a59 commit 189eece
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Copy Document as HTML

Plugin for [Obsidian](https://obsidian.md) that copies the current document to the clipboard, so it can be pasted into
HTML aware application like gmail.
Plugin for [Obsidian](https://obsidian.md) that copies the current document to the clipboard, so it can be pasted into HTML aware application like gmail.

This plugin exposes the `Copy document as HTML: Copy the current document to clipboard` command, which can be bound to a
keyboard shortcut.
This plugin exposes the `Copy document as HTML: Copy the current document to clipboard` command, which can be bound to a keyboard shortcut.

![image](https://user-images.githubusercontent.com/2441349/202304790-aea2a29e-2ed8-4ba2-bfb6-caaeb823e6f0.png)

## Features

Expand Down Expand Up @@ -36,15 +36,9 @@ The plugin converts image references to data urls, so no references to the vault
- Special fields (front-matter, double-colon attributes, ...) are not removed.
- data-uris can use a lot of memory for big/many pictures

## TODO / wish-list

- Adjust image resolution / quality

## INSTALL
## Install

If you want to check this out before this plugin is approved as a community plugin, you may use the [Obsidian
BRAT](https://github.com/TfTHacker/obsidian42-brat) plugin to install it. Point it to this url :
https://github.com/mvdkwast/obsidian-copy-as-html
Look for *Copy document as HTML* in the community plugin section in the Obsidian settings.

Don't be afraid to comment if anything seems wrong !

Expand All @@ -54,5 +48,7 @@ Please see the [Obsidian sample plugin](https://github.com/obsidianmd/obsidian-s

## Credits

Oliver Balfour for his [obsidian-pandoc](https://github.com/OliverBalfour/obsidian-pandoc) plugin, which helped me solve
- Oliver Balfour for his [obsidian-pandoc](https://github.com/OliverBalfour/obsidian-pandoc) plugin, which helped me solve
some rendering issues.
- TfTHacker for his [BRAT](https://github.com/TfTHacker/obsidian42-brat) plugin which makes beta-testing a breeze.
- PJ Eby for his [Hot-reload](https://github.com/pjeby/hot-reload) plugins which makes plugin development fast and fun.

0 comments on commit 189eece

Please sign in to comment.