Markdown - Art of writing project documentation

Markdown - Art of writing project documentation

Markdown was created by the John Gruber in 2004. It’s meant to be an easy to read and write syntax which converts easily to HTML (and now many other formats as well).

markdown.png

Know more about Markdown.

Markdown is a lightweight markup language. It allows us to style a digital text document using typical formatting techniques like headings, emphasis, lists, images, and links. It is stored as .md extensions. Also, Markdown can be optionally converted into XHTML or HTML to display nicely in a browser.

Where Markdown is Used

Some of the many uses of Markdown are creating documentations or readme guide to handle any programming codes or applications like readme files, writing messages in online discussion forums, creating rich text using a plain text editor, emails, and technical documentation.

Markdown is so popular and easy to use that it is used by some of the big companies communities include GitHub, Trello, Reddit, SourceForge, and StackExchange and ofcourse this hashnode too.

Advantages of Markdown

  • It is a plaintext formatting style.
  • It is easy to write.
  • It reduces distractions.
  • It does not include any fancy commands.
  • It increases the productivity due to less focus on fancy styles.
  • It can be converted to HTML.
  • It does not use any tags.
  • It includes clear and precise commands.
  • It is a free markup language.

Quick Cheat sheet for Markdown Syntax

Element.jpg

Learn for once and use forever

It’s a reusable skill. Markdown is versatile, so you learn it once, and you can use it for lots of different activities. You can use Markdown to take notes, create content for a website, or create print-ready documents.