DEV Community

Cover image for Learning Markdown: yeah, that Dev.to Editor Syntax
Tosin Adewale
Tosin Adewale

Posted on

Learning Markdown: yeah, that Dev.to Editor Syntax

If you have been writing on Dev.to recently or even for awhile, you must have certainly come across the symbols (#,* etc) in the in-built text editor. For instance, to make a text or word bold, you just need to add 2 asterisk at the beginning and end of the word, just like this BOLD.

Markdown

Markdown

If you are as curious as me, you must have at some point felt like this is different from all of the regular word processor (like Microsoft Word) used locally on computer systems. And if just like me, you have also written on Medium, Hashnode, or even Github Documentation, you must noticed the same type of syntax. Which begs the question, what are these signs and symbols all about. Well, I looked and found the culprit - MARKDOWN

4 Basic Facts About Markdown

  1. Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on code storage or blogging platforms.

  2. Markdown was created by John Gruber in 2004, and since then it is now one of the world's most popular markup languages on the internet.

  3. Creating a Markdown file is as simple as using a text editor or a dedicated Markdown application to create a text file and save the file with a .md or .markdown extension.

  4. You can style texts in Markdown as well as add images, links, tables, lists and even emojis with ease. Which makes it viable for creating presentation slides.

Why Do People Use Markdown instead of Popular Word Processors.

  1. Markdown is extremely lightweight. The files occupy less disk space compared to .docx, .pptx or .doc file extensions.
  2. Markdown files do not require specialized software to open them. Compared to other files types (.docx, .pptx or .doc etc) that can only be opened by proprietary software, Markdown is portable.

  3. The fact that Markdown files do not required specialized software to open them also makes them taotally platform independent. They can be opened with a simple text editor, and all platform regardless of the maker comes along with a text editor.

  4. Again, since Markdown files do not required specialized software to open them you do not have to worry if the application you are using suddenly stops working, there will always be other text editors that can similarly open the Markdown file. Imagine your MS Word software crashes, accessing contents of a .docx or .doc file is impossible on your computer locally, but with a .md or .markdown file extension, you can open with other text editors - Notepad, Notepad++, Atom, Sublime Text, VS Code, the options are endless.

What Is Markdown Used For?

Using Markdown for basic writing seems plausible, until you start asking yourself why should you use it instead of your normal word processor with buttons and clicks.

  1. WEB - Markdown was designed for the web in the first place , so it shouldn't come as a surprise that most of these online editors and static site generators use Markdown. The reason being that it is easier to update website content using Markdown instead of users having to go deep into the HTML or CSS source code to make a text bold
<b>
Enter fullscreen mode Exit fullscreen mode

or add a link using

<a href>
Enter fullscreen mode Exit fullscreen mode

Some of the static site generators like Jekyll, Hugo use Markdown to update contents they are not built to connect to a database for CRUD Operation, so the best method is to have users use Markdown to manually create and update contents on the website.

  1. DOCUMENT- By using a Markdown document authoring application, you can create and export Markdown-formatted documents to PDF or HTML files.
    Below are some Markdown document authoring applications:
    Windows: Ghostwriter, Markdown Monster
    iOS/ Android: iA Writer
    Web: Dillinger or Stack Edit
    Linux: ReText, Ghostwriter

  2. DOCUMENTATION - Companies like Github use a flavoured version of Markdown to host documentations. If you have been using Github for awhile , you must have noticed the numerous "README.md" files which mostly contain technical documentation regarding a repo or one's profile summary.

  3. COLLABORATION - For some popular collaboration and team messaging applications like like Slack and Discord, they support some features of Markdown, thus bolding or italicising text on such platforms can be done easily with Markdown.

Summary

In the course of this article, we have learnt 4 Basic Facts About Markdown, 4 Reasons Why People Use Markdown and 4 Areas Where We Can Use Markdown.

In the upcoming articles, we are going to learn how static site generators like Jekyll and Hugo use Markdown to update site contents.

I hope you have learnt something new today. Do not forget to try out Markdown to write documentations too. See you next time.

Top comments (0)