A 5-minute Markdown tutorial

Rebecca Dodd ·
Aug 17, 2018 · 1 min read · Leave a comment

At GitLab, we love Markdown for providing a simple, clean way to add styling and formatting to plain text, that's visible and repeatable across multiple applications. This means you can copy and paste the text without losing the formatting, and it makes reviewing diffs easier, as you're still reviewing plain text with no hidden data.

GitLab Product Marketing Manager William Chia recorded this five-minute Markdown tutorial for another GitLab team-member, so you can see how Markdown works within GitLab:

GitLab Flavored Markdown

GitLab uses GitLab Flavored Markdown (GFM) for other handy functionality not supported by standard Markdown. Here are a few useful things you can do with GFM:

Reference issues, commits, merge requests, or team members

When you type #12 (or any number) in an issue, it will automatically create a link to the corresponding issue in that project. You can also easily reference other GitLab-specific items.

You don't have to use the standard []() format to create a link: just pasting the URL will autolink it.

Create diagrams and flowcharts

In GitLab 10.3 we added the ability to generate diagrams and flowcharts using mermaid.

Quick actions

Open or close issues, reassign merge requests, add todos, unsubscribe from issues – these are just a few things you can do with GFM quick actions, all without leaving your keyboard. Just type / and a list of options will appear.

These are just a few examples of GFM – see the Markdown documentation for a full list. We're adding to it all the time: as of our last release you can quickly make an issue confidential right from the issue comment field. This was a community contribution, and we invite you to contribute functionality and quick actions you'd find useful too!

“A 5-minute #markdown tutorial by @TheWilliamChia” – Rebecca Dodd

Click to tweet

Open in Web IDE View source