Basic writing and formatting syntax
Create sophisticated formatting for your prose and code on GitHub with simple syntax.
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.
||command/control + b||
||This is bold text|
||command/control + i||
||This text is italicized|
||This was mistaken text|
|Bold and italic||
||This text is extremely important|
You can quote text with a
In the words of Abraham Lincoln: > Pardon my French
Tip: When viewing an issue or pull request, you can automatically quote text in a reply by highlighting the text, then typing
r. For more information, see "Using keyboard shortcuts."
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: GitHub automatically creates links when valid URLs are written in a comment. For more information, see "Autolinked references and URLS."
You can make a list by preceding one or more lines of text with
- 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 nested lists by indenting lines by two spaces.
1. Make my changes 1. Fix bug 2. Improve formatting * Make the headings bigger 2. Push my commits to GitHub 3. Open a pull request * Describe my changes * Mention all the members of my team * Ask for feedback
You can create task lists by prefacing list items with
[ ]. To mark a task as complete, use
Task lists render with checkboxes in all comments and Markdown files. Select or unselect the checkboxes to mark them as complete or incomplete.
- [x] Finish my changes - [ ] Push my commits to GitHub - [ ] Open a pull request
Mentioning users and teams
You can mention a user or team on GitHub by typing
@ plus their username or team name to bring their attention to an issue or pull request.
@github/support What do you think about these updates?
@ 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 hit either tab or enter to complete the name. For teams, just enter the @organization/team-name and all members of that team will get subscribed to the issue.
The autocomplete results are restricted to repository collaborators and any other participants on the thread.
Referencing issues and pull requests
You can bring up a list of suggested Issues and Pull Requests within the repository by typing
#. Type the issue or PR number or title to filter the list, then hit either tab or enter to complete the highlighted result.
For more information, see "Autolinked references and URLs."
You can add emoji to your writing by typing
@octocat :+1: This PR looks great - it's ready to merge! :shipit:
: 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.
Paragraphs and line breaks
You can create a new paragraph by leaving a blank line between lines of text.
Ignoring Markdown formatting
You can tell GitHub 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."