Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Eric Gradman authored and Eric Gradman committed Mar 16, 2022
1 parent c602330 commit 16cab40
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
# Etherpad-lite Obsidian Plugin

**This is a very pre-release version! This code is likely to change!**

My first draft of everything happens in Obsidian. The second draft usually happens in collaboration with others. I find myself cutting and pasting my work into a Google Doc, sharing the URL with coworkers, and replacing the original with a link to the Google Doc. This makes my work unsearchable, untaggable, and unlinkable.

This plugin uses an Etherpad-Lite server as a lightweight collaboration tool. Etherpad-Lite is a web-based editor with no frills. I've always thought of it as the "pastebin of editors." With this plugin, you can upload any note to an Etherpad-Lite server, share the URL, and allow others to collaboratively edit. The document remains in your vault. Each time it's opened, its contents will be replaced with the latest version from the Etherpad-Lite server.
Expand Down Expand Up @@ -38,14 +36,13 @@ Easier than it sounds. It can be done in AWS with a free-tier EC2 machine, or e

And don't forget to grab your API key from `APIKEY.txt`!

## Caveats

Etherpad-lite has some limited support for Markdown, but it's not really relevant to how this tool works. Any formatting (bold, italic, underline) that you use in the Etherpad version will be stripped when it's fetched into your vault.
I know. This part feels like a bait-and-switch.

Also, right now, list items are indented. I'll fix that.
## TODO

Just figure that the version that people are editing on the Etherpad Lite server is just Markdown.
- Command to disconnect document from Etherpad and delete remote version
- Auto-update of document when its open?

## Caveats

https://user-images.githubusercontent.com/103129/158699049-6d7801d9-82d0-416a-bcdb-dcdb6fd14987.mp4

0 comments on commit 16cab40

Please sign in to comment.