DEV Community

Cover image for A Complete Markdown Tutorial: From Basics to Advanced

A Complete Markdown Tutorial: From Basics to Advanced

MD MAHBUB UDDIN on October 24, 2024

Markdown is a lightweight markup language that makes it easy to format text. It’s used widely across many platforms like GitHub, Dev.to, and more f...
Collapse
 
morphzg profile image
MorphZG • Edited

Once you master markdown you will use it everywhere. Buty of it is plain text formated so it can display almost everywhere, even if it is displayed as plain text you will like the style. I use it mostly for note taking and readme files.

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Thanks for sharing how you use it—glad to hear from a fellow Markdown fan!

Collapse
 
oculus42 profile image
Samuel Rouse

Thanks for putting this together! Markdown is a great tool with a lot of capabilities, but the different versions create variations and ambiguities in the spec. This in turn creates headaches like the ones with your code examples.

Because of the different versions and implementation inconsistency I recommend adding two resources to your markdown arsenal:

  • CommonMark – A markdown specification with better clarity and compatibility
  • babelmark3 - A tool to see and compare the output of different markdown engines for a given input.
Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Thank you for the valuable feedback! 😊 You’re absolutely right—Markdown’s different versions can cause inconsistencies, which can be frustrating. Thanks again for sharing these great resources!

Collapse
 
nikhildev profile image
Nikhil Dev Chunchu

Some of the code block are no displaying properly, ex: Horizontal Lines
`markdown

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Thanks for the heads-up! It’s strange because the code blocks are displaying correctly on other platforms and even on Markdown viewers. I’ll look into why it’s not working here—it might be a platform-specific formatting issue. Appreciate your patience and feedback!

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Already Fixed this issue.

Collapse
 
programmerraja profile image
Boopathi

This is a fantastic overview of Markdown! I especially appreciate the clear examples and the breakdown of advanced features like code blocks and tables. This tutorial is a great resource for anyone wanting to learn Markdown.

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Thank you! 😊 I'm glad you found the tutorial helpful! Let me know if there's anything specific you'd like to see in future Markdown tips.

Collapse
 
gokayburuc profile image
gokayburuc.dev

Add also Github TOC

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Already Added. Thanks Again

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Great suggestion! I'll add a section on creating a TOC for GitHub soon. Thanks for the idea—stay tuned!

Collapse
 
martinbaun profile image
Martin Baun

Wonderfully written and researched!

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Thanks for checking it out! Let me know if there’s anything specific you’d like me to cover next time!

Collapse
 
istiquritconsultant profile image
Istiqur Rahman

I have liked your writing.
I am from Bangladesh too. I am glad to be a part of the community.

Collapse
 
mahbubumithu profile image
MD MAHBUB UDDIN

Thank you so much brother! 😊 Glad to have you in the community—let’s keep learning and growing together!