🖋️ Markdown

About

Overview

• Format used for GitHub Readme.md files, StackOverflow, and etc.
• Created by John Gruber and Aaron Swartz in 2004
• There are many versions of Markdown with different features.
  • Use Markdown and/or HTML code that is universal across versions.

Resources

• Wikipedia
• markdownguide.org: Basic Syntax

Topics

Indent sub-items

• Two or three spaces depending on the implementation
• An empty line break between items is required in some implementations

Images

• Adding images to markdown pages with alt, title, height and width attributes by W3Schools
• Captions
  • Use italic text right after the image
  • Optionally

Center items

• Markdown Center a Text, Image, Title, or Table by Markdown Land
• center HTML tag is deprecated
  • See The Centered Text element by MDN

Equality

• Greater than or equals
  • $\ge$
  • \(\ge\)
• Less than or equals
  • $\le$
  • \(\le\)

Embed

• How can I embed a YouTube video on GitHub wiki pages? on StackOverflow

Represent keyboard input

• <kbd>: The Keyboard Input element by MDN

Equation formatting

• In line
  • $1 + 1$
  • \(1 + 1\)
• Page centered
  • $$1 + 1$$
    \[1 + 1\]

Line break

• <br/>
• \
• See How to add new line in Markdown presentation? on StackOverflow

Strikethrough

• ~~Strike this out~~
• <s>Strike this out</s>
• Strike this out
• See Does Markdown have a way to express strikeout? on StackOverflow

Highlight

• How to add text highlight in markdown example by W3Schools

Subscript

• $CO_2$
• CO<sub>2</sub>_
• \(CO_2\)

Superscript

• $MC^2$
• MC<sup>2</sup>
• \(MC^2\)

Escape characters

• Use a backslash: \
• See Basic Syntax > Characters You Can Escape by markdownguide.org

Comments

• Handbook Markdown Guide > Comments by GitLab

Links

Organize links

• Wrap link text: (some link text)[1]
  • Provide link at the bottom of the page: [1]: [www.somelinktext.com](http://www.somelinktext.com)

Email

• mailto:[e-mail]
  • Do not include prefix https://

Phone

• US: tel:[phone]
• Int'l: tel:[phone]

Open in a new tab

• <a href="https://duckduckgo.com" target="_blank">Duck Duck Go</a>

Tables

About

• Markdown formatting that doesn't work in tables: Headings, lists, line breaks, images, horizontal rules, and blockquotes
• You have to use HTML

Convert a table from a Google document

• Use Docs to Markdown
• See Documents (Gdocs) open info (OI)

HTML table builders

• UI to build a table
  • tablesgenerator.com
    • Build complex tables in HTML to copy and paste into Markdown files.
    • E.g. Text fonts, sizing, lists, and etc.
    • Save and load tables
    • Opportunity
      • Indent text within cells: Indenting Paragraphs in HTML — All You Need to Know by html-tuts.com
  • HackMD
• Convert CSV and other delimited data into a Markdown table
  • tableconvert.com
  • markdown Table Maker by Jake Bathman

Center a table

• Markdown Center a Text, Image, Title, or Table by Markdown Land

Resources

• markdownguide.org
  • Extended Syntax > Tables
  • Hacks > Table Formatting
• markdown.land
  • How to Create a Great Looking Table
  • SQLite Markdown: Format Query Results In Markdown

Style and theme

• Use style tags to implement CSS in a .md file.
• Define HTML elements to customize inside the tags.
• HTML style tag by W3Schools
• HTML elements reference by Mozilla

This is not technical advice. Always read the official documentation and do your own research.