tobsef / boostnote-markdown-cheatsheet Goto Github PK

I believe that where you wrote <=> you should have wrote <==>. The former does not work

Which version do you use for the project?

I am currently using the Windows desktop version 0.16.1(2020.9.5) but I can't see the results as you showed.

Your

Mine

Trying to view the "code" of the cheatsheet does not show you the raw code as you would view in the Boostnote Editor as the github markdown parser interpolates that markdown symbols make it a jumbled mess. Furthermore, trying to copy and paste the raw text of the "code" cheatsheet doesn't render properly in Boostnote either (which honestly would make the most sense) because there are many places where the markdown code has been slashed-out so it renders literally in preview. The result is another different jumbled mess. Looking at the raw text it appears that some of the markdown is clearly intended to not be interpolated, but a lot of it which I'd have expected to be also be (such as the rudimentary emphasis code) is clearly meant to be interpolated- why, I have no idea. It's what I would call a "mish-mash". I don't one can disable MDE for a block of text in github if that is at all possible, but it's clear that trying to escape every single markdown token is a nightmare. I honestly am not sure what the intent of the "cheatsheet" mode is even for if it is clearly not intended to show the code.

It might just be easiest to write the cheatsheet in a manner that is just be pasted in Boostnote so you just have the cheatsheet in in your notes and see exactly how it will be rendered because... that's what's doing the interpolation! Honestly, I am not sure why a comprehensive cheatsheet isn't included with the example documents in the first place as one of the starter docs since the guide has zero markdown tips. I don't get this at all.

Examples use a png from the Boostnote.io website which no longer exist. Therefore demo is broken.

Replace https://boostnote.io/assets/img/logo.png with https://boostnote.io/static/images/logo_with_text_teal.svg

If you enable it in the settings Interface > Preview > Convert textual arrows to beautiful signs. ⚠ This will interfere with using HTML comments in your Markdown. some textual arrows will be converted to beautiful ones (it is done by https://github.com/adam-p/markdown-it-smartarrows) therefore the following arrows work:
--> →
<-- ←
<--> ↔
==> ⇒
<== ⇐
<==> ⇔