Express yourself with Markdown

Laptop and cup of coffee with flower on desk

Markdown support has just been introduced in MantisHub with our latest release. We chose to implement markdown to provide a simple way for our users to format their text within issue notes and descriptions. Markdown uses simple markup that gets translated in to HTML so you can display formatted text in MantisHub.

Development focused sites such as GitHub, Bitbucket and Visual Studio Online, use the power of markdown to greatly enhance their online user discussions. HTML is quite cumbersome to have to write up just to format your text so markdown is a huge time saver.

NoteExample-2Now Markdown doesn’t do any of the really fancy stuff like changing font size or color, or adding borders but it covers the basics like italics, bold, lists, linked text, embedded images, code snippets, etc. The emphasis of markdown language being ease of use as well as making sure your notes are still readable even when not rendered into HTML.

It was originally developed by John Gruber who supported the ideas of different implementations to suit individual user requirements so there are a few versions out there and many extensions on the functionality included in the original. The supported format for MantisHub can be found at parsedown.org.

If you are unfamiliar with Markdown, it’s very simple to pick up, just as emojis have become second nature, you’ll find it’s the same with markdown. Take a few minutes to familiarize yourself with shorthand and you’ll be using it seamlessly when updating your tickets. To get you started, we recommend checking out this short tutorial.

There’s also a cheat sheet you can keep bookmarked as you become more fluent.

For details on how to set up markdown in your MantisHub, check out our KB article.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s