Plugin: Share note online via HackMD

tessus · 2022-01-21T18:56:45.622Z

I was thinking about writing a plugin to share via gist, but gists can't do images (as in I can't upload images), thus I guess I won't write it after all.

This HackMD plugin is a great alternative.

xardbaiz · 2022-01-22T09:04:13.905Z

@tessus
Thanks

FYI: HackMD also doesn't support image uploading that's why they use imgur as external image hosting. It's visible in the browser DEV console when image attachment is in progress

tessus · 2022-01-23T00:24:30.107Z

I wanted to avoid writing a wrapper for imgur when publishing a gist. I wanted to have everything on gh. e.g. I can paste/upload images to issues.

HackMD does not natively do images, but I think they provide an API.

koyj · 2022-01-24T17:30:24.368Z

I can't find the screen to config - can you help ?

Joplin 2.6.10 (prod, win32)
plugin version : 1.0.1

xardbaiz · 2022-02-03T18:13:57.931Z

@koyj it should be there. Try to reinstall the plugin

xardbaiz · 2022-02-03T18:24:04.594Z

@samej your feature request status:

I've done with tags adding to note metadata but seems like they are appearing on HackMD only after indexation, which can be caused by manual editing (at least one symbol change) on the web interface. See GIF:

(test note is here)

So it requires more time to call HackMD indexation from the plugin via WebSockets.
WebSockets operations aren't in the SDK, so I don't even know yet is it possible or not.

If it's ok for you to manually open the note each time after uploading - you can manually install version 1.1.0b

graphit0 · 2022-02-03T22:39:38.771Z

@xardbaiz
Out of curiosity, what's your opinion on HackMD open source forks?

HedgeDoc: independent fork. It has quite a few public servers aside from the main demo one.
CodiMD: the main open source core

I don't follow the main differences, except forks allow much more freedom than HackMD (number of collaborators, size, etc). I'm just curious if you have considered the forks in your project and had a strong opinion about them or they just didn't appear on your radar?

xardbaiz · 2022-02-04T07:16:13.393Z

@graphit0 Yes I've explored them. But only Hack MD has a free web version with persistent notes storage. CodiMD & HedgeDoc work only on-premise, in local environment == not global.
That's why I chose HMD. To share links globally

BTW: talking about your feature request: I'm currently trying to run CodiMD or HedgeDoc locally with Docker Compose to check my plugin compatibility. But they don't want to connect to the DB
Maybe someone could help me with running those apps in Docker?

graphit0 · 2022-02-04T10:15:43.895Z

xardbaiz:

CodiMD & HedgeDoc work only on-premise, in local environment == not global.

Well, once again HedgeDoc does offer demo server/free web version and have a list of intended for public use servers (although they are not so easy to properly register on). But I agree that the service is young and not quite as reliable as HackMD. Infact, they cannot guarantee that the notes won't be deleted. In any case, gotcha!

xardbaiz:

Maybe someone could help me with running those apps in Docker?

Here's their support forum where you can describe the problem in detail and have someone guide you through the process.

HedgeDoc Community

Support

HedgeDoc support for everyone who prefers forums over chat. This should help to build a long-term support knowledge base.

There's also a matrix chat for quick questions

In fact there's an ongoing tread about the docker image at the moment

samej · 2022-02-07T20:34:52.906Z

Hi @xardbaiz, sorry for the delay in responding.
The last week has been extremely unusual for me.

I liked the result. I downloaded v1.1.0b and will do my tests, then (in the next few hours) I'll bring you feedback.

Thank you very much for your attention and dedication.

samej · 2022-02-08T01:30:09.541Z

Hello again @xardbaiz, as promised, here I am to bring you my feedbacks.

For some reason (I don't know), the plugin didn't work. The menu for entering HackMD login and password is not displayed in the corresponding location and the share icon does not appear on the toolbar.

Captura de tela_2022-02-07_22-10-061440×863 92.2 KB

Installed Plug-ins

Initially, I thought it was something related to the outdated version of Joplin, so I updated the app and it still didn't fix it. I installed other plugins that add icons to the toolbar and they worked perfectly.

image1440×863 215 KB

Toolbar and About Joplin v2.6.10 (AppImage)

I also tested the stable version of your plugin and the result remained the same, no login/password menu and no toolbar icon.

Here are some screenshots of my computer's settings:

image838×553 114 KB

Neofetch

image878×439 96.4 KB

Screenfetch

Note: the last time I tested Joplin-HackMD, it was on another HD that is not installed on my computer at the moment.

If you can guide me to carry out more tests, I would appreciate it!

Regards.

xardbaiz · 2022-02-08T11:09:09.247Z

@samej Have you tried to uninstall 1.0.1, restart Joplin and install 1.1.0b manually?

samej · 2022-02-09T01:41:49.028Z

@xardbaiz, yesterday I did this three times, to be exact. And the result was the same.

Today I tested again and the result I reported above remains.

koyj · 2022-02-13T17:57:03.381Z

@xardbaiz I tried reinstalling and still, it does not appear

xardbaiz · 2022-03-11T08:20:39.268Z

Excitement news !
API v2 Client - soon

Imperial_Squid · 2022-05-11T03:49:04.666Z

First off, fabulous plugin! I work in academia so it's super useful to be able to send notes off to people quickly and easily!

Just had a few questions:

Is it possible to set the note author to me?
- It's a bit annoying that the note permissions are set to everyone and can't be changed since I'm not the author...
- Also means I can't delete a note or, since note updating isn't implemented yet, can't update it remotely if I make a mistake...
Any updates on the other features mentioned?
- No pressure since I realise you probably have other stuff going on
- Just wondered if you had any updates about them, especially about updating an existing note

Again, massive thanks for making the plugin, as well as any answers you can give

xardbaiz · 2022-05-18T15:12:49.046Z

Hello everyone

@Imperial_Squid thanks for interesting and detailed feedback
You were right about my lack of time. I recently changed my job, so I don't have much free time now

All feature requests might be in the plugin which uses API v2 Client only (including: notes update, author, tags)
Cause the current(legacy) API is weak, not many settings there and almost no settings to change default access control (ACL). Let me check the ACL in new API and I will come back with answers

Imperial_Squid · 2022-05-26T12:29:14.825Z

Thanks for your reply!

No worries about the time thing, I realised that something had probably come up, no rush! I was actually considering learning typescript just to implement them myself but as you say, looks like you need to migrate to the new API and it looked a little daunting personally

I do know for sure that the new API lets you define permissions when you upload a note and also has a method for updating notes!

Just as a thought in advance: if you can set the permissions it's probably a good idea to let the user change the defaults in the settings. I would suggest a few things but I don't want to overwhelm you and it's your plugin besides!

Thanks again for the super useful creation

MikeKen-Ken · 2022-05-29T08:11:25.290Z

Hello. No response when I click share button. I tried using two hack accounts, but neither worked. Do you know why? Thanks you

robi · 2022-10-05T12:40:20.893Z

It would be great to enable self-hosted HackMD installs as a configuration target.