PR to fix markdown issue in GoLand IDE. Screenshot of issue is in image below.
Hi @joshRamirez, thanks for pointing at this.
To me this is a bug (or feature) in GoLand IDE, as $
is not required to be escaped in Markdown. Maybe you should report the issue to them?
Can confirm that Jetbrains products have very poor out-of-the-box support for Markdown in general, and that depending on the programming language, the editor can be really terrible or just plain bad. There used to be a really really good plugin for Markdown in the Jetbrains Marketplace, but it is no longer supported in more recent versions of the Jetbrains editors.
I would report a bug to Jetbrains, and see what they tell you about a workaround.
It is a PITA, but vs code, which is free, has really good support for markdown, and multiple plugins for rendering and editing, so you could open the docs there - even while using Goland as your code editor.
I opened up the Cars Assemble
instructions in my version of Goland (2020.3.2)
and it did not render the $
and the text that followed it as italics or italicized. It did “preview” the file with slashes in front of the $
however. Not sure if earlier/later versions of Goland behave differently.
Using code view versus preview might also help work around your Markdown issue, since you can define a stylesheet for how the Markdown language is highlighted.
One ray of hope on Jetbrains progress is that their Writerside app is aimed at producing documentation, and after a few iterations it is becoming quite good (though still at EAP/beta stage). I hope this will nudge them into taking Markdown more seriously across their product range.
Interesting. I have access to that, but never considered using it thus far. I should check it out, just to know what is out there.
IMHO, the Jetbrains propensity to make entirely new editors (that they charge extra for) for things they absolutely know people use in combination is a bit infuriating.
If I wanted to use a purpose-built editor for documentation ONLY, I’d use something like Typora or any number of other programs. But in the context of writing Exercism exercises that include runnable code examples, code files, test files, SVG, formulas (potentially) , and all sorts of other text – context shifting from one editor to another is really problematic for me.