Plugin: Publish to Web

My first plugin. Sometimes I've wanted to share a note, and I ended up putting it into evernote so I could do that easily.

This plugin will publish a note as a Github Gist [1]

You can install it via the Joplin plugin system.

Why?

  • You can easily share notes and update without having Joplin Cloud share
  • The version history that github allows is better than the version diff (which must be enabled) that Joplin nativly supports
  • Allows readers to make comments on content you share

Requirements

You need to create an auth token with gist scope here: github.com/settngs/tokens

Usage

After you have the token, click the github icon on your note

to do

  • upload referenced images
  • be able to update a note instead of creating a new each time

example

Change log


  1. Gists provide a simple way to share code snippets (in this case, notes) with others. Every gist is a Git repository, which means that it can be forked and cloned. If you are signed in to GitHub when you create a gist, the gist will be associated with your account and you will see it in your list of gists when you navigate to your gist home page. ↩︎

7 Likes

This is great, thanks!

One small suggestion (and I realize it may be too late) would be to name it either "Publish to Gist" or "Gist publsiher". Even having just installed it, when I went to try to find it on the plugin page I didn't think to look for it under "Joplin". Every plugin is for Joplin.

Anyway, this is a great plugin. Thanks so much for making it!

1 Like

I can remove the "Joplin" part if that helps. The reason I didn't call it something with Gist, is that I may expand it to publish to other services, like gitlab, or pastebin or whatever too.

4 Likes

Oh, cool. That's great to hear. Perhaps something like "Publish to Web".

Any way, great work. Thanks for taking the time to make this available.

2 Likes

I changed the name to "Publish to Web"

2 Likes

Hi there, where does the token go once we have it to enable the plugin ?

I'm seeing this at the moment : "HttpError: Requires authentication" which makes sense as I've not (as I don't know where) to put the token.

edit : I found it, I didn't associate "Publish" with "Publish to Web" in the options nav, though found it in the end :slight_smile:

2 Likes

Updated to version 1.1.0 which allows updating a gist. Persistent storage data for plugins that also get synced · Issue #8080 · laurent22/joplin · GitHub allowed this to happen.

2 Likes

Using it more a use-case that's very previous to me is revisions. Since the plugin updates the gist, you now get a nice git diff with differences from the different versions. It's a bit easier to deal with than the built-in Note History

1 Like