Markdown

Locations of key files/directories

• Basic config options: _config.yml
• Top navigation bar config: _data/navigation.yml
• Single pages: _pages/
• Collections of pages are .md or .html files in:
  • _publications/
  • _portfolio/
  • _posts/
  • _teaching/
  • _talks/
• Footer: _includes/footer.html
• Static files (like PDFs): /files/
• Profile image (can set in _config.yml): images/profile.png

Tips and hints

• Name a file “.md” to have it render in markdown, name it “.html” to render in HTML.
• Go to the commit list (on your repo) to find the last version Github built with Jekyll.
  • Green check: successful build
  • Orange circle: building
  • Red X: error
  • No icon: not built

Resources

• Liquid syntax guide
• MathJax Documentation

Markdown guide

Academic Pages uses kramdown for Markdown rendering, which has some differences from other Markdown implementations such as GitHub’s. In addition to this guide, please see the kramdown Syntax page for full documentation.

Footnotes

Footnotes can be useful for clarifying points in the text, or citing information.¹ Markdown support numeric footnotes, as well as text as long as the values are unique.²

This is the regular text.[^1] This is more regular text.[^note]

[^1]: This is the footnote itself.
[^note]: This is another footnote.

HTML Tags

Address Tag

Anchor Tag (aka. Link)

This is an example of a link.

Abbreviation Tag

The abbreviation CSS stands for “Cascading Style Sheets”.

Cite Tag

“Code is poetry.” —Automattic

Code Tag

You will learn later on in these tests that word-wrap: break-word; will be your best friend.

You can also write larger blocks of code with syntax highlighting supported for some languages, such as Python:

print('Hello World!')

or R:

print("Hello World!", quote = FALSE)

Strike Tag

This tag will let you strikeout text.

Emphasize Tag

The emphasize tag should italicize text.

Insert Tag

This tag should denote inserted text.

Keyboard Tag

This scarcely known tag emulates keyboard text, which is usually styled like the <code> tag.

Preformatted Tag

This tag styles large blocks of code.

.post-title {
  margin: 0 0 5px;
  font-weight: bold;
  font-size: 38px;
  line-height: 1.2;
  and here's a line of some really, really, really, really long text, just to see how the PRE tag handles it and to find out how it overflows;
}

Quote Tag

Developers, developers, developers… –Steve Ballmer

Strong Tag

This tag shows bold text.

Subscript Tag

Getting our science styling on with H₂O, which should push the “2” down.

Superscript Tag

Still sticking with science and Isaac Newton’s E = MC², which should lift the 2 up.

Variable Tag

This allows you to denote variables.

Footnotes

The footnotes in the page will be returned following this line, return to the section on Markdown Footnotes.