Plugin: Publish to Web

joeschmoe · 26 April 2023 23:25

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

gist.github.com

https://gist.github.com/danielb2/51430701b35539eb4f2e5ac70f1293f3

1. Welcome to Joplin!.md

# Welcome to Joplin!

Joplin is a free, open source note taking and to-do application, which helps you write and organise your notes, and synchronise them between your devices. The notes are searchable, can be copied, tagged and modified either from the application directly or from your own text editor. The notes are in [Markdown format](https://joplinapp.org/help/#markdown). Joplin is available as a **desktop**, **mobile** and **terminal** application.

The notes in this notebook give an overview of what Joplin can do and how to use it. In general, the three applications share roughly the same functionalities; any differences will be clearly indicated.

![](:/b8d5b1c17b0a43289197982cfc43d631)

## Joplin is divided into three parts

This file has been truncated. show original

Change log

version 1.1.0 (2023.06.27) adds ability to modify gists. Clicking the github button will now update a gist thanks to Persistent storage data for plugins that also get synced · Issue #8080 · laurent22/joplin · GitHub being implemented

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. ↩︎

whitewall · 27 April 2023 00:20

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!

joeschmoe · 27 April 2023 00:23

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.

whitewall · 27 April 2023 00:36

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.

joeschmoe · 28 April 2023 01:58

I changed the name to "Publish to Web"

JeremyHutchings · 10 June 2023 18:23

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

joeschmoe · 27 June 2023 22:51

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.

joeschmoe · 14 October 2023 17:12

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