DEV Community

Morgan Murrah
Morgan Murrah

Posted on

 

A brief note of love for Markdown


I have fond memories of using Markdown early on when I was learning to code which really started just over two years ago. When I was finding JavaScript challenging in one of my early projects I remember taking one afternoon to work through cheat sheets of Markdown syntax and make some nicely formatted ReadMe files.

A nicely formatted Markdown file as a ReadMe on Github with code formatted instructions to enter into the terminal can really make a difference in a developer's experience. There are many libraries and projects I possibly never read further about or experimented with because it did not have a clear ReadMe.

I still use Markdown today and its an incredibly portable format for blogs and lots of things.

MacDown is my simple markdown editor of choice on a mac with a live preview

Here's a sentence with a footnote. 1


  1. This is the footnote. ↩

Top comments (7)

Collapse
 
mikeodev profile image
Mike

Agreed, a nice markdown file goes a long way for readability within docs. I've recently got into using markdown myself for personal documentation. I've been using Typora as my markdown editor and love it so far.

My favorite part about markdown is the code snippets.

let x = 'an old game store'
funcoLand(x)
function funcoLand(x){
    console.log(x)
}
// not awake enough to make something more intriguing.
Collapse
 
tobalsan profile image
Thinh

Hey, you might want to check Typora. I used to use MacDown... until I discovered Rypora

Collapse
 
airbr profile image
Morgan Murrah

Late reply: I am now using Typora these days

Collapse
 
qthdh profile image
Thinh

awesome πŸ‘

Collapse
 
ben profile image
Ben Halpern

I ❀️ markdown too

Collapse
 
oresoftware profile image
Operations Research Engineering Software+

The value from the elite universities comes from excluding people

Collapse
 
airbr profile image
Morgan Murrah

?? I don't understand

Here is a post you might want to check out:

Regex for lazy developers

regex for lazy devs

Sorry for the callout πŸ˜†