Plugin: Publish to Web

joeschmoe · 2023-04-26T23:25:41.608Z

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
update a note instead of creating a new each time

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

Screen Shot 2023-04-26 at 16.23.511288×254 20 KB

to do

upload referenced images

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.2.0 (2024.08.16) can now choose public or private gist instead of only private
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 · 2023-04-27T00:20:27.401Z

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 · 2023-04-27T00:23:16.052Z

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 · 2023-04-27T00:36:15.647Z

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 · 2023-04-28T01:58:07.050Z

I changed the name to "Publish to Web"

JeremyHutchings · 2023-06-10T18:23:26.815Z

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 · 2023-06-27T22:51:31.763Z

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 · 2023-10-14T17:12:12.038Z

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

LeoW · 2024-01-08T11:32:05.345Z

Hi, I need some help getting started.

I've been using Joplin on Windows, Android, Linux, ChromeOS for about a month now.

I'm currently a paid subscriber to Evernote, and if I switch over to Joplin I still want the ability to publish notes to the web and I came across your plugin which looks like the perfect solution for me only I can't get the plug in to work. The "Publish note" option under note is grayed out and there is no GitHub icon to click on to publish anything.

I created the token and gave it all permissions and I still can't get in to Joplin to publish anything to my Gist.

I may have done something wrong only I don't know what.

Any suggestions?

Thanks.

Leo.

joeschmoe · 2024-01-08T12:14:24.610Z

There would be a GitHub icon on the note. You saved the api key in the plugin ?

LeoW · 2024-01-08T14:18:30.010Z

Got it.

Turns out I needed to toggle the note editor. When I did, the icon appeared, and I was able to upload the data.

Thanks.

B0BIC · 2024-01-23T15:18:57.504Z

Any chance you may someday support sharing entire notebooks?

joeschmoe · 2024-01-23T15:50:02.589Z

like one gist, multiple files? or one gist per note? I mean, either way, sure. feel free to file an issue on github. I don't know when tho

LeoW · 2024-01-23T16:42:24.961Z

I think @B0BIC is referring to selecting an actual notebook, rather than a single notebook.

I host my Joplin on my OneDrive and it would be awesome if somebody with developer skills that I certainly don't have could find a way to share a notebook with another person or place the same way that Joplin does it through their own cloud service just without having to use their cloud service.

I'm still very new to Joplin. I'm a long-term evernote user that is looking for an alternative to their rising prices.

joeschmoe · 2024-01-30T02:02:01.430Z

I think @B0BIC is referring to selecting an actual notebook, rather than a single notebook.

I don't understand what you're thinking the difference is between the two things you described here

enginpost · 2024-01-30T16:18:44.830Z

I am embedding images in my Notebook Note, and as I push to Gist (which I love) it seems to not migrate the image. Any advice? I figured out that I can change the image manually from being a PNG to being a markdown image with a data:uri, but it seems that Github doesn't present embedded data:uri images. Thoughts?

LeoW · 2024-01-30T22:08:00.231Z

Sorry, @joeschmoe , I doubled up on notebook.

Should have read:I think @B0BIC is referring to selecting a whole notebook, rather than a single note.

joeschmoe · 2024-01-31T04:38:01.844Z

oh right, yes that's how I read it. My question is around how to publish it. The two options are:

one gist with all the notes in it (probably the better option)
or multiple gists with one note in each

joeschmoe · 2024-01-31T04:40:02.685Z

I am embedding images in my Notebook Note, and as I push to Gist (which I love) it seems to not migrate the image. Any advice?

It's in my todo list in the first post. Just didn't get around to it yet. partially because I need to write code to make a round trip to get the urls of the uploaded image paths and replace them in the original note. I also didn't have much of a personal use-case yet to do it, but I want to do it

joeschmoe · 2024-08-16T16:04:42.918Z

just updated to be able to publish public gists instead of only private