In this post I talk about Markdown, and specifically why I started using it. Markdown is an easy way to write text that easily translates into HTML. According to its creator, John Gruber,

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML).

Personally, I was about to create a Machine Learning projects portfolio and learning markdown and realizing it’s potential served two purposes:

  1. Creating and maintaining a website/blog: I decided to go for Jekyll themed website/blog to publish my projects as it seemed like an option with least programming overhead. Jekyll automatically converts regular markdown to a nice webpage.

  2. Programming in a publication ready notebooks: I, simulatenously started programming in an iPython notebook, Jupyter, which supports Markdown.

The following two resources were enough for me to get started with markdown:

  • 5 mins on Interactive markdown tutorial: it covers most of the beginner level formatting.

  • 20 mins on this blog: beginner to advance level formatting.
  • Prose has advanced support for Jekyll sites and markdown content.

Below, I have documented some of the basic formatting options in markdown!

  • Here is some bold text

  • Here’s a simple table:

Number Next number Previous number
Five Six Four
Ten Eleven Nine
Seven Eight Six
Two Three One
  • here’s picture of a yummy crepe

Crepe

  • Here’s a code chunk:
var foo = function(x) {
  return(x + 5);
}
foo(3)
  • And here is the same code with syntax highlighting:
var foo = function(x) {
  return(x + 5);
}
foo(3)
  • And here is the same code yet again but with line numbers:
1
2
3
4
var foo = function(x) {
  return(x + 5);
}
foo(3)

I hope this was helpful to anyone who is thinking of getting started with markdown!