Plugin: Rich Markdown

GeoffW · 2023-11-23T07:10:47.806Z

Edited to say: I was indeed missing the obvious, please ignore this post (if you prefer I can delete it). I was getting confused as to who did what. The inconsistency is not in the plugin. Joplin is handling the whole markdown="1" thing even on the editor side.

Original content

Hi, I'm just trying this out for the first time. Looks good! But (you knew that was coming, didn't you ) ...

It appears to require the HTML attribute markdown="1" to be set before working inside embedded HTML blocks like div. I have two issues with this. First is that I have lots of notes written when I didn't know such an attribute was being introduced by various tools, and second it is inconsistent with how the Joplin preview works. See the attached screen capture.

clip02628×581 16.4 KB

The preview is always applying markdown against embedded HTML, while Rich Markdown requires markdown="1".

Ideally I'd like there to be a default in the options (to be used when the markdown= attribute is not specified). Possibly it should be in the Joplin App options to control how the preview details with it, and then maybe a separate option for this plugin? And then if the source provides an explicit markdown= attribute then that can override the default. That way we get to manage this according to our own history and preferences.

Please forgive me if I've missed something obvious. I looked for existing settings and didn't see one for this. Tried on both v2.12.8 and v2.13.6.

muzak · 2023-12-10T15:29:02.304Z

Would it be possible to expose focus mode's opacity level in the plugin settings?

nonobio · 2024-04-14T06:07:23.428Z

Hi @CalebJohn

Thanks a lot for this great plugin

About checkboxes:

Would it be possible to check the boxes of all selected text? (when I select several line and use the Toggle checkbox action from contextual menu, only the first line is toggled)

Check boxes on titles are not taken into account, would this be possible? In fact they are not seen as check boxes by the Joplin Markdown viewer either, but I put x myself manually to simulate a check mark:

Thanks

CalebJohn · 2024-04-15T06:27:51.576Z

nonobio:

Would it be possible to check the boxes of all selected text? (when I select several line and use the Toggle checkbox action from contextual menu, only the first line is toggled)

That's a good point, it would make sense to apply to all of them. What do you think the behavior should be if a user selects multiple lines that have both checked and unchecked boxes?

Toggle all individually
Uncheck all
Check all

nonobio:

Check boxes on titles are not taken into account, would this be possible? In fact they are not seen as check boxes by the Joplin Markdown viewer either, but I put x myself manually to simulate a check mark:

I hesitate to add features that don't exist in the markdown viewer, i think it adds confusion for most users. I would consider adding support for that header checkbox syntax (I saw it in a thread from a few days ago), if/when it's supported in the main app.

nonobio · 2024-04-15T06:51:28.951Z

Thank you very much for your response

CalebJohn:

That's a good point, it would make sense to apply to all of them. What do you think the behavior should be if a user selects multiple lines that have both checked and unchecked boxes?

Toggle all individually

Uncheck all

Check all

The ideal would be to have the 3 options . The ones that would be most useful to me would be 2 and 3 (Uncheck all and Check all)

If this is not possible, and if the function is still called Toggle checkbox, the most logical one would be Toggle all individually.

I also use the plugin Reset Checkboxes which allows me to Uncheck all checkboxes, and following my request to the developer @kamer, he added the possibility of uncheck checkboxes only on the selected text, thanks to him

With your 2 plugins, the checkboxes will be under control

CalebJohn:

I hesitate to add features that don't exist in the markdown viewer, i think it adds confusion for most users. I would consider adding support for that header checkbox syntax (I saw it in a thread from a few days ago), if/when it's supported in the main app.

I understand
In this regard, although checking and unchecking these boxes on the title does not work, when you press CTRL the little hand is displayed, we might believe that it could work, but no

CalebJohn · 2024-04-17T18:50:41.996Z

nonobio:

In this regard, although checking and unchecking these boxes on the title does not work, when you press CTRL the little hand is displayed, we might believe that it could work, but no

Fair point! I'll look into making it work (or fixing the hand, we'll see)
edit: It was fairly easy to add the requested feature. It will be available in the next release.

CalebJohn · 2024-04-17T21:08:10.262Z

Version 0.15.0 was just released. It supports checking selections.

The ctrl+click (and ctrl+enter) behaviour remains the same (toggle checkboxes). But this adds 2 new right-click menu entries, one for check all, and one for uncheck all.

I also went ahead and added support for toggling titles that are formatted like checkboxes.

nonobio · 2024-04-18T13:17:56.695Z

Wow, amazing, thank you very much, it is perfect

In the Markdown viewer, title checkboxes cannot be checked or unchecked with a click, but I don't think the plugin can do anything about it...

nonobio · 2024-05-16T08:23:41.472Z

Hi,

I noticed two little issues:

1- Checkboxes actions of the context menu are not displayed if the last line of the selection does not contain a checkbox:

Joplin_2024-05-16_10-16-16

I've gotten into the habit of paying attention to the end of my selection and so I can live with this behavior, but I wanted to point this out to you in case there is an easy way to correct this

2- Internal links to anchors of other notes do not work from the editor (CTRL) if the titles contain checkboxes. If I remove the checkbox from the link, it works whether the box is checked or not:

Joplin Rich Markdown_Anchor links with checkboxes issue_2024-05-16_16-42-56

As for the first problem, I can live with it, I wonder if it is not better to remove the check box from the link, which means that it will work, whether the box is checked or not

Thanks

The fact that I don't necessarily arrive at the right section in the note linked is, I think, another problem.

CalebJohn · 2024-05-17T18:29:18.576Z

Thank you for the reports @nonobio, I don't have time to fix them right away but I've tracked them on github so they don't get lost.

github.com/CalebJohn/joplin-rich-markdown

Checkboxes actions of the context menu are not displayed if the last line of the selection does not contain a checkbox

opened 06:25PM - 17 May 24 UTC

CalebJohn

bug

This is because the current code uses the location of the cursor to determine th…e items to add to the context menu. This needs to be fixed for multiline selections, so that the correct prompt is present. ![image](https://github.com/CalebJohn/joplin-rich-markdown/assets/2179547/bc1fa6d5-4055-45d8-a92c-7a6e6361df15) [source: nonobio on discourse](https://discourse.joplinapp.org/t/plugin-rich-markdown/15053/369?u=calebjohn)

github.com/CalebJohn/joplin-rich-markdown

Internal links with checkboxes in the title cannot be clicked

opened 06:27PM - 17 May 24 UTC

CalebJohn

bug

This is likely caused by an overly greedy checkbox regex which is hijacking the …section. ![image](https://github.com/CalebJohn/joplin-rich-markdown/assets/2179547/85e95002-2f2c-466f-b2c9-77638bfea919) [source: nonobio on discourse](https://discourse.joplinapp.org/t/plugin-rich-markdown/15053/369?u=calebjohn)

And as for anchor links not scrolling to the right place, that is indeed a limitation of the current version, it is high priority for me to fix.

github.com/CalebJohn/joplin-rich-markdown

Support scrolling to footers and anchor links

opened 05:40PM - 29 Oct 23 UTC

CalebJohn

[ref](https://discourse.joplinapp.org/t/plugin-rich-markdown/15053/349)

nonobio · 2024-05-18T05:56:38.132Z

Thanks

CalebJohn:

And as for anchor links not scrolling to the right place, that is indeed a limitation of the current version, it is high priority for me to fix.

Are you talking about the current version of Rich Markdown or Joplin?
Because for me the problem is present even without any plugin installed (without Rich Markdown).

There are two things I notice:

Sometimes the note is not positioned at all in the right place, whether in the editor or the renderer.
Sometimes it is positioned well in the renderer but not in the editor (this is where I have to move the text up or down on the renderer side so that the editor aligns it).

CalebJohn · 2024-05-19T18:30:53.274Z

I was talking about rich markdown, but I see now that you're talking about a different issue. You should report it on the Joplin issue tracker.

GitHub

Issues · laurent22/joplin

Joplin - the secure note taking and to-do app with synchronisation capabilities for Windows, macOS, Linux, Android and iOS. - Issues · laurent22/joplin

nonobio · 2024-05-20T09:42:04.682Z

Thanks, it's done:

github.com/laurent22/joplin

Anchor links works only in renderer and not everytime

opened 09:39AM - 20 May 24 UTC

nonobio

bug

### Operating system Windows ### Joplin version 3.0.6 ### Desktop ve…rsion info Joplin 3.0.6 (prod, win32) ID client : 1442e227e6af42d19aa8f41041c138ef Version de Synchro : 3 Version du profil : 47 Trousseau supporté : Oui Révision : 18b9f5c Backup: 1.4.1 Note overview: 1.7.1 Note Tabs: 1.4.0 Outline: 1.5.13 Rich Markdown: 0.15.0 Search & Replace: 2.2.0 ### Current behaviour Hi, When I click on an anchor link of another note, Joplin goes to the other note but sometimes positions itself at the beginning of the note (I seem to see the right section briefly). Moreover, even when it works, it is only in the renderer panel and not in the editor. To put the editor in the right place, I have to move the text up or down in the viewer. ![20240429 Joplin liens anchor fonctionnent mal et seulement dans rendu](https://github.com/laurent22/joplin/assets/7425799/6f76c1a0-511b-40cf-9514-a2c23bffe156) I tried deactivating all my plugins, but the problem is still present. Thanks ### Expected behaviour The renderer and editor should be positioned in the right place ### Llinks Topic on forum: https://discourse.joplinapp.org/t/anchor-links-works-only-in-renderer-and-not-everytime/38137

nickzeff · 2024-05-24T03:16:27.608Z

Hey @CalebJohn ... sorry for being cheeky, but thought I would try my luck again...

Do you think any chance of implementing PDF preview being displayed inline in the markdown editor, especially since v3 has now added support for loading PDFs with imaging API.

I am fine for you to give the same answer as last time, but thought I would forward this new info

github.com/laurent22/joplin

Desktop: Resolves #9794: Plugin API: Add support for loading PDFs with the imaging API

laurent22:dev ← personalizedrefrigerator:pr/plugin-api/pdf-to-image-api

opened 04:37PM - 21 Mar 24 UTC

personalizedrefrigerator

+303 -75

# Summary Resolves #9794. Adds a plugin API to convert PDFs to images. …Specifically, it adds the following: - `joplin.imaging.createFromPdfResource` - `joplin.imaging.createFromPdfPath`: Creates images from a PDF file (one per page). Returns a handle to each page. It also makes the following changes to existing methods: - `joplin.imaging.createFromResource` and `joplin.imaging.createFromPath`: If given a path to a pdf resource or file (based on the file extension), return an image of its first page. - `joplin.imaging.free`: Support freeing an array of image handles. # Testing This pull request updates the `imaging` example plugin to use the new APIs. To manually test this pull request using that plugin, 1. Open a note that contains a PDF link in the markdown editor. 2. Select the PDF link. 3. Click on the second gear icon in the toolbar. 4. Verify that images for the first 10 pages are inserted into the note.

shikuz · 2024-05-25T12:58:05.659Z

Wanted to share some RM CSS tricks. Each one is made up of two parts:

JSON to be pasted into the settings at Rich Markdown --> Advanced Settings --> Custom classes JSON. This creates new CSS classes out of text patterns.
CSS to be pasted into Joplin's userchrome.css (AKA Appearance --> Custom stylesheet for Joplin-wide app styles).

Highlight tags in the editor

Preview:

image1072×116 18.6 KB

JSON:

[{ "name": "rm-tag", "regex": "(?<=^|\\s)([#@+]|\\/\\/)([^\\s#@+]*\\w)" }]

CSS:

div.CodeMirror span.cm-rm-tag {
    background-color: #7698b3;
    color: white !important;
    padding: 0em 2px;
    border-radius: 5px;
    display: inline;
}

Colour-coded checkboxes in the editor

Preview:

These [x]it!-inspired checkbox styles represent various possible states of tasks. (See also this plugin, which renders these checkboxes in a panel.)

JSON:

[{
	"name": "rm-xitOpen",
	"regex": "(?<=^\\s*)[-+*] \\[ \\](?=\\s.*)"
},
{
	"name": "rm-xitDone",
	"regex": "(?<=^\\s*)[-+*] \\[x\\](?=\\s.*)"
},
{
	"name": "rm-xitOngoing",
	"regex": "(?<=^\\s*)[-+*] \\[@\\](?=\\s.*)"
},
{
	"name": "rm-xitObsolete",
	"regex": "(?<=^\\s*)[-+*] \\[~\\](?=\\s.*)"
},
{
	"name": "rm-xitInQuestion",
	"regex": "(?<=^\\s*)[-+*] \\[\\?\\](?=\\s.*)"
},
{
	"name": "rm-xitBlocked",
	"regex": "(?<=^\\s*)[-+*] \\[!\\](?=\\s.*)"
}]

CSS:

I included an extra commented line in each class for optionally highlighting the checkbox.

div.CodeMirror .cm-rm-xitOpen { /* Add * after the class for CM6 */
    font-family: monospace !important;
    color: #4178be !important;
    font-weight: bold !important;
    /* background-color: #a3c3f5 !important; */
}

div.CodeMirror .cm-rm-xitDone { /* Add * after the class for CM6 */
    font-family: monospace !important;
    color: #64a073 !important;
    font-weight: bold !important;
    /* background-color: #b9d7bf !important; */
}

div.CodeMirror .cm-rm-xitOngoing { /* Add * after the class for CM6 */
    font-family: monospace !important;
    color: #cb55c2 !important;
    font-weight: bold !important;
    /* background-color: #ebace8 !important; */
}

div.CodeMirror .cm-rm-xitObsolete { /* Add * after the class for CM6 */
    font-family: monospace !important;
    color: #999999 !important;
    font-weight: bold !important;
    /* background-color: #c4c4c4 !important; */
}

div.CodeMirror .cm-rm-xitInQuestion { /* Add * after the class for CM6 */
    font-family: monospace !important;
    color: #cc913f !important;
    font-weight: bold !important;
    /* background-color: #e9c79f !important; */
}

div.CodeMirror .cm-rm-xitBlocked { /* Add * after the class for CM6 */
    font-family: monospace !important;
    color: #e22d2d !important;
    font-weight: bold !important;
    /* background-color: #f5aaaa !important; */
}

restreachi · 2024-06-07T23:48:29.298Z

Does anybody know if this plugin is known to be safe privacy-wise? Their latest version 15.0.0 doesn't seem to be on Github...

CalebJohn · 2024-06-08T00:06:33.950Z

v0.15.0 is on github, I just didn't bother manually creating a github "release" for it. I just pressed the release button so it should be safe now

Lombra · 2024-07-09T18:21:39.540Z

Hi,

Is this plugin supported in version 3.x? I just updated Joplin to 3.0.13 and installed this plugin (0.15.0), but I have a few of issues and/or don't understand how it works.

Are "plain text" links supposed to get styled automatically? I can Ctrl-click to follow them, but they are not colored or anything.

Using Stylish, horizontal rules that have spaces in between the characters (eg * * *) are rendered strangely. Even with spaces it looks a little strange, with the markdown barely visible and a tiny cursor. I also don't get any side margin like in the screenshot, which causes the header markdown to disappear.

I have enabled the "add extra CSS classes" option.

bild

graphit0 · 2024-07-16T12:48:07.279Z

Before I create the issue, I'd like to ask if this feature is interesting enough to be in scope for this plugin

Clickable URL on image

![ [image label to display](URL) ](/:resourceid)

Example: label underneath the image is supposed to be clickable - opens Youtube page

720×404 48.9 KB

Fig 1. Joplin Tutorial - Joplin Note-Taking App Tutorial - YouTube

Code for the preview block: ![[Joplin Tutorial - Joplin Note-Taking App Tutorial - YouTube](https://www.youtube.com/watch?v=emiwyNQa12Q)](upload://nrUa7d8DKTMlOEkwtnbSLJz8fs6.jpeg)

Use cases

Video/webpage thumbnail preview (can automated with Custom Copy of FoxyTab Firefox Plugin)
app launcher dashboard grid
attachments preview
? potential note preview
webarchive: potential to easily recreate static HTTP elements in note's body

Notes

CM6 renderer supports this feature out of the box but it doesn't work in TinyMC
This feature is more like a markdown hack but surprisingly supported widely enough, although underutilized for some reason

artis · 2024-08-01T06:48:54.980Z

Thank you for your custom checklist setup.
Is there a way to define how it!-inspired checkbox styles are displayed in the viewer or when exported to PDF?
For example, to make that [?], [@], [!] & [~] are also displayed as bullet points or bullet points with specific formatting.

Additionally, is it possible to do the same thing for tags - to have the same highlighting in rendered markdown output?