Example Markdown Post

• Basic setup
• Basic formatting
• Lists
• Boxes and stuff
• Images
• Code
• Tables
• Tweetcards
• Footnotes

Basic setup

Jekyll requires blog post files to be named according to the following format:

YEAR-MONTH-DAY-filename.md

Where YEAR is a four-digit number, MONTH and DAY are both two-digit numbers, and filename is whatever file name you choose, to remind yourself what this post is about. .md is the file extension for markdown files.

The first line of the file should start with a single hash character, then a space, then your title. This is how you create a “level 1 heading” in markdown. Then you can create level 2, 3, etc headings as you wish but repeating the hash character, such as you see in the line ## File names above.

Basic formatting

You can use italics, bold, code font text, and create links. Here’s a footnote ¹. Here’s a horizontal rule:

---

Lists

Here’s a list:

• item 1
• item 2

And a numbered list:

1. item 1
2. item 2

Boxes and stuff

This is a quotation

You can include alert boxes

…and…

You can include info boxes

Images

Code

General preformatted text:

# Do a thing
do_thing()

Python code and output:

# Prints '2'
print(1+1)

2

Tables

Column 1	Column 2
A thing	Another thing

Tweetcards

Altair 4.0 is released! https://t.co/PCyrIOTcvv
Try it with:

pip install -U altair

The full list of changes is at https://t.co/roXmzcsT58 ...read on for some highlights. pic.twitter.com/vWJ0ZveKbZ

— Jake VanderPlas (@jakevdp) December 11, 2019

Footnotes

1. This is the footnote. ↩