Intro to Markdown, Benefits & Drawbacks

If you've ever been on GitHub and looked through a repository you've likely come across the file "README.md". This file is written in Markdown.

Markdown is a lightweight markup language used to format text. It offers a simple and intuitive syntax for creating headings, lists, tables, links, and other formatting elements that can be easily converted into HTML, PDF, or other formats.

Let's look through the syntax below

Benefits of Markdown

1. Markdown is simple and intuitive. You don't need to learn a lot of tags or commands to use Markdown. You can use symbols like asterisks, dashes, and brackets to create headings, lists, links, images, and other elements. For example, to create a heading, you just need to start a line with one or more hash signs (#). To create a link, you just need to enclose the link text in square brackets ([ ]) and the URL in parentheses (( )). You can also use Markdown editors or tools that provide a preview of how your text will look like when rendered in HTML.
2. Markdown is portable and compatible. You can write Markdown in any text editor or application that supports plain text. You can also convert Markdown to HTML or other formats using various tools and libraries. This means you can use Markdown for different purposes and platforms, such as websites, blogs, newsletters, ebooks, slideshows, and more. You can also easily share your Markdown files with others without worrying about compatibility issues.
3. Markdown is flexible and extensible. You can customize Markdown to suit your needs and preferences. You can use different flavors or extensions of Markdown that add more features or functionality to the basic syntax. For example, you can use GitHub Flavored Markdown (GFM) to add tables, task lists, code blocks with syntax highlighting, and more. You can also use plugins or scripts that enhance Markdown with additional elements or effects.

Drawbacks of Markdown

1. Markdown is not standardized. There is no official specification or authority for Markdown. Different implementations or parsers of Markdown may have different behaviors or interpretations of the syntax. This can lead to inconsistencies or conflicts when using Markdown across different platforms or tools. For example, some Markdown parsers may not support certain features or extensions that others do. Some may also have bugs or errors that affect the rendering of your text.
2. Markdown is limited in functionality. While Markdown is designed to be simple and minimalistic, it may not be enough for some complex or advanced formatting needs. For example, Markdown does not have native support for footnotes, tables of contents, citations, cross-references, mathematical equations, charts, diagrams, and more. You may need to use HTML tags or external tools to achieve these effects in Markdown. However, this may compromise the readability or portability of your text.
3. Markdown is not universally supported. Not all applications or platforms support Markdown natively or fully. You may need to install plugins or extensions to enable Markdown support in some cases. For example, some word processors or email clients may not recognize or render Markdown syntax correctly. Some websites or services may also have their own markup languages or editors that are incompatible with Markdown. You may need to convert your Markdown files to other formats before using them in these situations.

Wrapping it up

That should give you a good introduction to the markdown language. It's simple, elegant, and versatile. You can use it to write anything from blog posts to books, from code snippets to tables. Markdown is the ultimate tool for content creation. I hope you enjoyed this article and learned something new. If you did, please share it with your friends and leave a comment below.

Resources

• Markdown Cheatsheet
• Github Markdown Cheatsheet
• Basic Syntax | Markdown Guide