21st August, 2020 | 4min read

Markdown is a markup language like HTML. It is quite popular among developers to write blogs, readme files, documentation and blogs. Some of the popular websites that support rich text like Reddit, GitHub, Notion etc allow you to write markdown. I use markdown to convert my blog from a markdown file to HTML web pages. Markdown is simple yet very powerful. In this blog, I will be writing about how to build a simple markdown parser to convert md to HTML with JavaScript using Regular Expressions.

For a complete list of all formatting usages, you may read the Reddit Markdown Primer or Comment Formatting. Websites like GitHub and reddit use Markdown to style their comments. Formatting text in Markdown has a very gentle learning curve. It doesn’t do anything fancy like change the font size, color, or type. All you have control over is the display of the text—stuff like making. Websites like Reddit and GitHub support Markdown, and lots of desktop and web-based applications support it. Kicking the Tires The best way to get started with Markdown is to use it. Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is appealing to human readers in its source code form. Markdown is widely used in blogging, instant messaging, online forums, collaborative software, documentation pages, and readme files.

How does a markdown text look like

If you open a markdown file, you'll see the following syntax.

Learn more from this markdown cheatsheet.

Regular Expressions

A regular expression is a character sequence that helps us to capture patterns in a text. We can use it to validate user input, find and replace texts and yup, you guessed it, build our markdown parser. 😉

Different languages have different ways to represent RegEx. Here is how it is done in JavaScript.

I will explain the patterns we use in our parser as we reach that section. However, if you want to read more about regular expressions, visit https://javascript.info.

Markdown parser

The markdown parser I intend to build is a function that takes markdown text as input and returns HTML.

Here, we want to find a certain pattern in markdownText and perform replace operations.

String replace function

Our markdown parser is simple. It captures a pattern from markdown string passed to the function as markdownText argument and replaces it with certain HTML pattern.

Here is how the string replace function works.

Note: Here the i flag represents case insensitive and g flag represents global, which means it matches patterns everywhere on the string, not just the first match.

Capturing groups in Regular Expression

Regular Expressions allows us to capture patterns of text and reference them with something like an index. We can use the index in the replace operation. To represent a group, we can simply wrap it in a parenthesis ().

Here, we have stored the starting hello in a group. The group can then be referenced with $1 on our replace operation.

Reddit Markdown Link

Back to the parser

Now, we want to parse the markdown text and replace it with HTML.

Here are the RegExes we will use in our parser and their explanation.

1. Heading
   For heading, we want a string that starts with a hash(es) and captures everything after those characters.

   Here the first carat ^ represents line starting with and m flag represents multiple lines and by doing .* we are capturing everything (letters, numbers, special characters) that exists there.

2. Blockquote
   For blockquote, we want a line that starts with > and captures everything after that character.

   Note: > represents escaping > character. That means, don't treat > as a part of special regEx character but as a part of that text itself.

3. Bold Text
   For bold text, we want to capture a text between 2 asterisks.

4. Italics Text
   For italic text, we want to capture a text between one asterisk.

5. For image, link and line break
   

Fitting it all together

Reddit Markdown Link

By this point, you probably have all the background necessary to understand the concepts. Let's fit all the things that we have learnt up to now and build the parser.

Reddit Markdown Spoiler

Time to test the parser.

Should print:

Our markdown parser is now completed. It doesn't cover everything that markdown supports. Try implementing them and share the solution with me via twitter.