DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Testing, Deployment, and Maintenance
  3. DevOps and CI/CD
  4. A 5-Minute Markdown Tutorial [Video]

A 5-Minute Markdown Tutorial [Video]

Markdown is a clean way to add styling and formatting to plain text, that's visible and repeatable across multiple applications.

Rebecca Dodd user avatar by
Rebecca Dodd
·
Aug. 27, 18 · Tutorial
Like (1)
Save
Tweet
Share
5.82K Views

Join the DZone community and get the full member experience.

Join For Free

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 GitLabber, 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!

GitLab Plain text Requests Flowchart Diagram Merge (version control) Links application

Published at DZone with permission of Rebecca Dodd, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • How To Create and Edit Excel XLSX Documents in Java
  • Load Balancing Pattern
  • Distributed SQL: An Alternative to Database Sharding
  • Real-Time Stream Processing With Hazelcast and StreamNative

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: