| title | description |
|---|---|
My Example Markdown Document |
An awesome description |
The following is copied from GitHub
To create a heading, add one to six # symbols before your heading text. The number of # you use will determine the size of the heading.
# The largest heading
## The second largest heading
###### The smallest heading
You can indicate emphasis with bold, italic, or strikethrough text.
| Style | Syntax | Keyboard shortcut | Example | Output |
|---|---|---|---|---|
| Bold | ** ** or __ __ |
command/control + b | **This is bold text** |
This is bold text |
| Italic | * * or _ _ |
command/control + i | *This text is italicized* |
This text is italicized |
| Strikethrough | ~~ ~~ |
~~This was mistaken text~~ |
||
| Bold and nested italic | ** ** and _ _ |
**This text is _extremely_ important** |
This text is extremely important | |
| All bold and italic | *** *** |
***All this text is important*** |
All this text is important |
You can quote text with a >.
In the words of Abraham Lincoln:
> Pardon my French
{% tip %}
Tip: When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing r. You can quote an entire comment by clicking {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then Quote reply. For more information about keyboard shortcuts, see "Keyboard shortcuts."
{% endtip %}
You can call out code or a command within a sentence with single backticks. The text within the backticks will not be formatted.
Use `git status` to list all new or modified files that haven't yet been committed.
To format code or text into its own distinct block, use triple backticks.
Some basic Git commands are: ``` git status git add git commit ```
For more information, see "Creating and highlighting code blocks."
You can create an inline link by wrapping link text in brackets [ ], and then wrapping the URL in parentheses ( ). You can also use the keyboard shortcut command + k to create a link.
This site was built using [GitHub Pages](https://pages.github.com/).
{% tip %}
Tip: {% data variables.product.product_name %} automatically creates links when valid URLs are written in a comment. For more information, see "Autolinked references and URLS."
{% endtip %}
{% data reusables.repositories.section-links %}
{% data reusables.repositories.relative-links %}
You can make an unordered list by preceding one or more lines of text with - or *.
- George Washington
- John Adams
- Thomas Jefferson
To order your list, precede each line with a number.
1. James Madison
2. James Monroe
3. John Quincy Adams
You can create a nested list by indenting one or more list items below another item.
To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like Atom, you can align your list visually. Type space characters in front of your nested list item, until the list marker character (- or *) lies directly below the first character of the text in the item above it.
1. First list item
- First nested list item
- Second nested list item
To create a nested list in the comment editor on {% data variables.product.product_name %}, which doesn't use a monospaced font, you can look at the list item immediately above the nested list and count the number of characters that appear before the content of the item. Then type that number of space characters in front of the nested list item.
In this example, you could add a nested list item under the list item 100. First list item by indenting the nested list item a minimum of five spaces, since there are five characters (100. ) before First list item.
100. First list item
- First nested list item
You can create multiple levels of nested lists using the same method. For example, because the first nested list item has seven spaces (␣␣␣␣␣-␣) before the nested list content First nested list item, you would need to indent the second nested list item by seven spaces.
100. First list item
- First nested list item
- Second nested list item
For more examples, see the GitHub Flavored Markdown Spec.
{% data reusables.repositories.task-list-markdown %}
If a task list item description begins with a parenthesis, you'll need to escape it with \:
- [ ] \(Optional) Open a followup issue
For more information, see "About task lists."
You can mention a person or team on {% data variables.product.product_name %} by typing @ plus their username or team name. This will trigger a notification and bring their attention to the conversation. People will also receive a notification if you edit a comment to mention their username or team name. For more information about notifications, see {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "[email protected]" or currentVersion == "github-ae@latest" %}"About notifications{% else %}"About notifications{% endif %}."
@github/support What do you think about these updates?
When you mention a parent team, members of its child teams also receive notifications, simplifying communication with multiple groups of people. For more information, see "About teams."
Typing an @ symbol will bring up a list of people or teams on a project. The list filters as you type, so once you find the name of the person or team you are looking for, you can use the arrow keys to select it and press either tab or enter to complete the name. For teams, enter the @organization/team-name and all members of that team will get subscribed to the conversation.
The autocomplete results are restricted to repository collaborators and any other participants on the thread.
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.
For more information, see "Autolinked references and URLs."
{% data reusables.repositories.autolink-references %}
Some {% data variables.product.prodname_github_app %}s provide information in {% data variables.product.product_name %} for URLs that link to their registered domains. {% data variables.product.product_name %} renders the information provided by the app under the URL in the body or comment of an issue or pull request.
To see content attachments, you must have a {% data variables.product.prodname_github_app %} that uses the Content Attachments API installed on the repository.{% if currentVersion == "free-pro-team@latest" %} For more information, see "Installing an app in your personal account" and "Installing an app in your organization."{% endif %}
Content attachments will not be displayed for URLs that are part of a markdown link.
For more information about building a {% data variables.product.prodname_github_app %} that uses content attachments, see "Using Content Attachments."
You can add emoji to your writing by typing :EMOJICODE:.
@octocat :+1: This PR looks great - it's ready to merge! :shipit:
Typing : will bring up a list of suggested emoji. The list will filter as you type, so once you find the emoji you're looking for, press Tab or Enter to complete the highlighted result.
For a full list of available emoji and codes, check out emoji-cheat-sheet.com.
You can create a new paragraph by leaving a blank line between lines of text.
You can tell {% data variables.product.product_name %} to ignore (or escape) Markdown formatting by using \ before the Markdown character.
Let's rename \*our-new-project\* to \*our-old-project\*.
For more information, see Daring Fireball's "Markdown Syntax."
- {% data variables.product.prodname_dotcom %} Flavored Markdown Spec
- "About writing and formatting on GitHub"
- "Working with advanced formatting"
- "Mastering Markdown"
To embed YouTube videos to Markdown, reference videos as shown here.
Example embedded video:
video: https://www.youtube.com/watch?v=jne4auRnxJ4&feature=youtu.be