loading...

These lifehacks will change the way you write Markdown!

Yechiel Kalmenson on August 16, 2019

If you're a developer, chances are you've come across markdown editors before (whether you know it or not). Markdown is supported by GitHub, DEV, ... [Read Full]
markdown guide
 

I had no idea about the diff highlight! Can you combine it with a JS syntax highlight?

Im definitely using this in my next tutorials btw. Thanks a bunch for the article!

 

As far as I know you can't have two languages selected so if you have diff there's no way to add another language.

That's why I only use diff when it's a change of a few characters, if the change is more than a line I'll use they language for the syntax highlighting.

 

My best markdown lifehack is to ditch it in favor of asciidoc as soon as you are doing something non trivial.

Simple things should be easy, complex things should be possible said a wise man. Markdown got only the first part right. Asciidoc is as easy as markdown for the simple things but won't let you down if you do something more complex

asciidoctor.org/docs/user-manual/#...

 

If I really need more complex I might just use good ol' latex

 

Which really is the only time where I need something more complex than markdown.

That's what I thought also, but in fact markdown is never enough if you look at it closely :

  • on GitHub I'm using "markdown plus" some GitHub extensions
  • on dev.to, I'm using "markdown plus" some handy native liquid tags
  • with a static site generator, I'm using "markdown plus" a static front matter thingy

The question then is whether to use multiple incompatible "markdown plus extension" or a standardized better format like asciidoc.

 

Love Markdown and this article.
Nice job!

There is a small error, in the Javascript and Diff examples, they are mixed.

To beginners I'll suggest to install a preview extension into VSCode and maybe another extension to handle Markdown shortcuts.

 

Thank you!

What do you mean that they are mixed? It seems right to me... πŸ€”

 

Nevermind, it must be something regarding the renderer on the DEV Android app, or it was me that was just tired after a long week! πŸ˜…

 
 

Nice list! I also like to use angle brackets <> around links with no text, quotations with >, and footnotes via the Extended Syntax (supported by GitHub Pages for example). markdownguide.org/extended-syntax/

 

Javascript and diff, of course. But many, many more. Check out the complete list on Github.

 

Yes! I didn't mean to imply JavaScript was the only one, I brought it as an example. Most people I've spoken to didn't know about diff though, so that was the main one I wanted to point out.

 
 
 

diff looks awesome! I never knew that would work like it does :) nice - thanks!

 

Didn't know about diff.
Will deffo use diff

Thank you!

 

Just tried it in Joplin (OneNote-like app using Markdown syntax) and it works wonderfully, thanks for the tip!

 
 
 

Wonderful article! I'm using a project management software and they allow us to write Markdown as well. I will definitely use your advice!

 
code of conduct - report abuse