Skip to content
G GBTI

What is Markdown? A quick introduction to Markdown (.md) format

  • devops
  • frameworks
What is Markdown? A quick introduction to Markdown (.md) format

Markdown is a lightweight markup language created by John Gruber and Aaron Swartz in 2004. It was designed to be an easy-to-read and easy-to-write format that can be converted to HTML. Markdown has become a popular tool for formatting text on the web, especially in platforms like GitHub, Reddit, and various blogging services.

Key Features of Markdown

  1. Simplicity: One of Markdown’s biggest advantages is its simplicity. Unlike HTML, which requires a more complex syntax, Markdown uses plain text formatting, which makes it easy to learn and use.
  2. Readability: The primary goal of Markdown is to be as readable as possible in its raw form. This means that even without being converted to HTML, Markdown files are easy to read.
  3. Compatibility: Markdown can be converted to many other formats, such as HTML, PDF, and DOCX, using various tools and converters. This makes it highly versatile for different applications.

Basic Syntax

Markdown uses simple characters and symbols to denote different types of formatting. Here are some of the basic syntax elements:

  • Headers: Headers are created using the # symbol. The number of # symbols indicates the level of the header.

# Header 1 ## Header 2 ### Header 3

  • Emphasis: Text can be italicized using single asterisks or underscores, and bolded using double asterisks or underscores.

*Italic* or _Italic_ **Bold** or __Bold__

  • Lists: Markdown supports both ordered and unordered lists.
  • Unordered lists use asterisks, plus signs, or hyphens.
    “`markdown
    • Item 1
    • Item 2
      “`
  • Ordered lists use numbers followed by periods. 1. First item 2. Second item
  • Links and Images: Links are created using square brackets for the text and parentheses for the URL.

[OpenAI](https://www.openai.com) Images follow a similar syntax but start with an exclamation mark.

![Alt text](image-url)

  • Code: Inline code is wrapped in backticks, while code blocks are indented with four spaces or wrapped in triple backticks.

`inline code` Code block or

``` Code block

Uses of Markdown

Markdown is widely used for various purposes, including:

  • Documentation: Developers use Markdown to write project documentation due to its simplicity and readability.
  • Blogging: Many blogging platforms support Markdown, allowing authors to write and format their posts easily.
  • Notes: Tools like Joplin and Obsidian support Markdown for taking notes, making it easy to organize and format text.

Closing

Markdown has revolutionized the way we format text for the web. Its simplicity and readability make it accessible to everyone, from developers to writers. Whether you’re documenting a project, writing a blog post, or taking notes, Markdown provides a straightforward way to create well-formatted text.

For more detailed information, you can visit the official Markdown Guide.

A creator co-op, powered by Git

Join the GBTI Network

The GBTI Network is a creator co-op. Members showcase their work, write articles, share in co-op profits, and meet in weekly coaching calls with the community.

Publish your profile, blog posts, products, and prompts
Share in co-op profits
Join weekly coaching calls with the community

A 90-day limited-access trial lets you evaluate the community before you pay. Paid membership is $150 per year and unlocks your public presence on the network: your profile, blog, products, and prompts.

0 Comments

No comments yet. Be the first. Members comment from the GBTI local client, where comments are submitted as pull requests and auto-published for paid members.

Become a member

Members write comments from the GBTI client or browser extension. Become a member to join the conversation.

Written by

GBTI Network

Published 29th Jul 2024

View profile
Contribution history
No tracked contributions yet. A member who improves this article through an accepted pull request earns a share of the revenue it generates.

Imported from the legacy WordPress site, so the earliest edits live there. Everything since is tracked here as member contributions.

Full history on GitHub Spotted something? Become a member to contribute.

Related posts

Sign in with the GBTI extension

Signing in and publishing happen through the free GBTI browser extension. It keeps your GitHub sign-in on your own machine and lets you edit and publish in place.

The Chrome Web Store listing is coming soon. For now, the download page walks you through loading it as an unpacked extension.