seleneyang / markdown-portfolio Goto Github PK

Username and Team @mentions

Typing an @ symbol, followed by a username, will notify that person to come and view the comment. This is called an “@mention”, because you’re mentioning the individual. You can also @mention teams within an organization.

@githubteacher

@githubteacher

Cross Links

You can bring up a list of suggested Issues and Pull Requests within the repository by typing #. Type the Issue or Pull Request number or title to filter the list, and then press either tab or enter to complete the highlighted result.

Additionally, references to Issues and Pull Requests are automatically converted to shortened links to the Issue or Pull Request. For example,

Linking Specific Commits

References to a commit's ID (commonly called a SHA or hash) are automatically converted into shortened links to the commit on GitHub. For example,

Quotes

You can quote text with a >.

In the words of Abraham Lincoln:

> Pardon my French

In the words of Abraham Lincoln:

Pardon my French

Tables

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

```
First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
```

Inline Code Blocks

Sometimes, it makes text easier to read if you specify a certain term as code. The word "code" in the previous sentence was distinguished in markdown with inline code blocks.

Inline code is just one ``` character on either side of the text, and can be used within paragraphs, headers, or other markdown.

`inline code is just one backtick`

inline code is just one backtick

Separate Code Blocks

If you need to separate out a larger block of code, use three ``` characters instead of one, and set the text aside in its own paragraph. This is how the course shows you how markdown looks without actually formatting it.

Anything put in this **paragraph** will not be _formatted_ even if it would normally be recognized in this setting. :taco:

Anything put in this paragraph will not be formatted even if it would normally be recognized in this setting. 🌮

Syntax Highlighting

In addition to code blocks, you can specify how the code should be formatted by language. For example, when we add the language after the first three ``` characters, the formatting is specific to the programming language.

What we type:
javascript function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }

What we see:

function fancyAlert(arg) {
  if(arg) {
    $.facebox({div:'#foo'})
  }
}

Summary dropdown

You might have noticed that most of the text in this issue is formatted in summary dropdowns. Here's how to make them with Markdown:

<details>
  <summary>Quotes</summary>

  Content here

</details>