Skip to content
D-Key edited this page Mar 29, 2012 · 8 revisions

Welcome to the Mark5 wiki!

Mark5 is a Google Chrome extension that makes markdown reading nice and simple.

One day I was working with a bunch of github projects, each having a few .md files, and realized that there was no application on my box that could show them in a nicely rendered way. Well, since there are javascript converters that would render markdown into HTML, why not use them Google Chrome to handle this? That's how Mark5 was created (don't ask me why it's #5 and where are the previous 4).

OK, the next day I've googled a bit and found out that there are extensions doing exactly the same thing, but it was too late - Mark5 was out there.

Installation and First Time Setup

Mark5 works with internet markdown files, though its primary goal was to nicely render the local .md|.markdown texts. Local files rendering requires some configuration; please follow steps 2-4 below to enable it.

  1. In Chrome browser download mark5.crx, and press "Install" button when "Confirm Installation" dialog appears.
  2. Open Options > Extensions
  3. Click on the triangle to the left from Mark5 section to expand it
  4. Tick "Allow access to file URLs"
    check this

How it Works

  • Mark5 checks file address and re-renders the page using markdown syntax if extension matches '.md', '.mdown', '.markdown', or '.mkdn*'.
  • Gears button on the sidebar gives an option of choosing from 4 themes (light and dark, serif and sans-serif) and 4 font sizes to adjust the page to your liking. Mark5 will remember the settings and use them for all markdown files. You can try changing themes or font size right now, it works on this page too.
  • When printing Mark5 hides the sidebar and adds a section with link URLs at the end of the document.
    Press Ctrl+P to check it out in Chrome print preview.

Credits

The people, pages, and projects that made this extension possible. In no particular order.

  1. John Gruber - the farther of the markdown
  2. John Fraser, Dana Robinson, and Stack Exchange - the authors of the pagedown project
  3. jQuery - the turning point in web development
  4. GoSquared - free and commercial icons resource.
  5. Google - for making Chrome. ;)