A complete beginners guide to Markdown

Markdown is a lightweight markup language designed to simplify the process of formatting plain text documents. It was invented by John Gruber and Aaron Swartz in 2004 as a way to create easily readable and writable content for the web without the complexity of HTML.

What is Markdown?

Markdown is a plain text formatting syntax that allows you to add formatting elements to documents using simple and intuitive characters. It’s designed to be:

  • Easy to read and write in its raw form
  • Convertible to structurally valid HTML or XHTML
  • Portable across different platforms and applications

Why was Markdown invented?

Markdown was created out of frustration with the complexity of formatting web content using standard HTML. The inventors aimed to develop a simpler alternative that would make it easier for people to write for the web without getting bogged down in complicated markup tags.

Why is Markdown so useful?

Markdown offers several advantages that make it incredibly useful:

  1. Simplicity: The syntax is straightforward and easy to learn, making it accessible to beginners.

  2. Readability: Markdown documents are easy to read even in their raw form, which enhances collaboration and documentation efforts.

  3. Versatility: It supports basic formatting elements like headings, lists, bold and italic text, links, and code blocks, making it suitable for various writing tasks.

  4. Platform independence: Markdown files can be created and edited on any device or operating system.

  5. Portability: Markdown documents can be opened in any text editor and are supported by most platforms and tools.

  6. Efficiency: Users can quickly format text without the need for complex formatting tools or software.

  7. Integration: Markdown integrates well with other tools and applications, such as GitHub, Slack, and WordPress.

Why is it called Markdown?

The name “Markdown” is a play on words, derived from the term “markup,” which refers to the process of adding formatting instructions to a document. The creators chose this name to emphasize the simplicity and lightweight nature of the language compared to more complex markup languages like HTML.

By using Markdown, writers, developers, and content creators can focus on their writing without getting distracted by complex formatting syntax. Its widespread adoption across various platforms and applications has made it an essential tool for anyone working with digital content.

Markdown commands

Here’s a comprehensive list of Markdown commands:

Text Formatting

  • Bold: **text** or __text__
  • Italic: *text* or _text_
  • Strikethrough: ~~text~~
  • Inline code: `code`
  • Subscript: H~2~O
  • Superscript: X^2^

Headings

  • Heading 1: # Heading 1

  • Heading 2: ## Heading 2

  • Heading 3: ### Heading 3

  • Heading 4: #### Heading 4

  • Heading 5: ##### Heading 5
  • Heading 6: ###### Heading 6

Lists

  • Unordered list: - item or * item or + item
  • Ordered list: 1. item
  • Task list: - [ ] task (unchecked) or - [x] task (checked)

Links and Images

  • Link: [link text](URL)
  • Image: ![alt text](image URL)
  • Reference-style link: [link text][reference] then [reference]: URL

Blockquotes

  • Single line: > quoted text
  • Nested: >> nested quote

Code Blocks

  • Fenced code block: ` code
  • Syntax highlighting: ` python code

Horizontal Rule

  • --- or *** or ___

Tables

| Header 1 | Header 2 |
| -------- | -------- |
| Cell 1   | Cell 2   |

Escaping Characters

  • Use backslash: *not italic*

Line Breaks

  • Two spaces at end of line or <br>

Footnotes

  • Here's a sentence with a footnote. [^1]
  • [^1]: This is the footnote.

Definition Lists

term
: definition

Emoji

  • :emoji_code:

Task Lists

  • - [ ] Unchecked task
  • - [x] Checked task

Highlighting

  • ==highlighted text==

Comments

Leave a Reply

Your email address will not be published. Required fields are marked *