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
Academic Pages uses Jekyll Kramdown, GitHub Flavored Markdown (GFM) parser, which is similar to the version of Markdown used on GitHub, but may have some minor differences.
- Some of emoji supported on GitHub should be supposed via the Jemoji plugin .
- The best list of the supported emoji can be found in the Emojis for Jekyll via Jemoji blog post.

Resources

MathJax

Support for MathJax Version 3.0 is included in the template:

\[\displaylines{ \nabla \cdot E= \frac{\rho}{\epsilon_0} \\\ \nabla \cdot B=0 \\\ \nabla \times E= -\partial_tB \\\ \nabla \times B = \mu_0 \left(J + \varepsilon_0 \partial_t E \right) }\]

The default delimiters of $$...$$ and \\[...\\] are supported for displayed mathematics, while \$...\$ should be used for in-line mathematics (ex., $a^2 + b^2 = c^2$)

Note that since Academic Pages uses Markdown which cases some interference with MathJax and LaTeX for escaping characters and new lines, although some workarounds exist.

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.

Header three

Header four

Header five

Header six

Blockquotes

Single line blockquote:

Quotes are cool.

Tables

Table 1

Entry	Item
John Doe	2016	Description of the item in the list
Jane Doe	2019	Description of the item in the list
Doe Doe	2022	Description of the item in the list

Table 2

Header1	Header2	Header3
cell1	cell2	cell3
cell4	ce
ll5	cell6
cell1	cell2	cell3
cell4	cell5	cell6
Foot1	Foot2	Foot3

Definition Lists

Definition List Title: Definition list division.
Startup: A startup company or startup is a company or temporary organization designed to search for a repeatable and scalable business model.
#dowork: Coined by Rob Dyrdek and his personal body guard Christopher “Big Black” Boykins, “Do Work” works as a self motivator, to motivating your friends.
Do It Live: I’ll let Bill O’Reilly explain this one.

Unordered Lists (Nested)

List item one
- List item one
  - List item one
  - List item two
  - List item three
  - List item four
- List item two
- List item three
- List item four
List item two
List item three
List item four

Ordered List (Nested)

List item one
1. List item one
  1. List item one
  2. List item two
  3. List item three
  4. List item four
2. List item two
3. List item three
4. List item four
List item two
List item three
List item four

Buttons

Make any link standout more when applying the .btn class.

Notices

Basic notices or call-outs are supported using the following syntax:

**Watch out!** You can also add notices by appending `{: .notice}` to the line following paragraph.
{: .notice}

which wil render as:

Watch out! You can also add notices by appending {: .notice} to the line following paragraph.

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

1 Infinite Loop
Cupertino, CA 95014
United States

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)

Details Tag (collapsible sections)

The HTML <details> tag works well with Markdown and allows you to include collapsible sections, see W3Schools for more information on how to use the tag.

Collapsed by default

This section was collapsed by default!

The source code:

<details>
  <summary>Collapsed by default</summary>
  This section was collapsed by default!
</details>

Or, you can leave a section open by default by including the open attribute in the tag:

Open by default

This section is open by default thanks to open in the <details open> tag!

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

Strike Tag

This tag will let you ~~strikeout text~~.

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.

Such as this footnote. ↩
When using text for footnotes markers, no spaces are permitted in the name. ↩

Yuchen Zhu