Markdown Github Guide

You can pick one of GitHub’s pre-made themes for your website, use a Jekyll theme, or use your own custom CSS. Shown below is a sample webpage using one of GitHub’s pre-made themes. Confusingly, GitHub Pages renders Markdown differently than GitHub does. GitHub uses its own Markdown processor; GitHub Pages uses kramdown. Markdown is an easy to use syntax for styling and formatting writing on the internet. Most likely, you’ve seen it used for GitHub READMEs. Most likely, you’ve seen it used for GitHub READMEs. When developing new applications, it’s always a good idea to create a well-written, informative, and well-styled README to accompany your project.

Markdown Style Guide
Markdown Github Guide
Markdown Github Guidelines

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

Markdown guide

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	cell5	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

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

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”.

Markdown Style Guide

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.

Strike Tag

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

Emphasize Tag

The emphasize tag should italicize text.

Markdown Github Guide

Insert Tag

This tag should denote 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.

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

Markdown Github Guidelines

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

Variable Tag

This allows you to denote variables.