Working with advanced formatting

Formatting like tables, syntax highlighting, and automatic linking allows you to arrange complex information clearly in your pull requests, issues, and comments.

Organizing information with tables→
You can build tables to organize information in comments, issues, pull requests, and wikis.
Organizing information with collapsed sections→
You can streamline your Markdown by creating a collapsed section with the <details> tag.
Creating and highlighting code blocks→
Share samples of code with fenced code blocks and enabling syntax highlighting.
Autolinked references and URLs→
References to URLs, issues, pull requests, and commits are automatically shortened and converted into links.
Attaching files→
You can convey information by attaching a variety of file types to your issues and pull requests.
Creating a permanent link to a code snippet→
You can create a permanent link to a specific line or range of lines of code in a specific version of a file or pull request.
Using keywords in issues and pull requests→
Use keywords to link an issue and pull request or to mark an issue or pull request as a duplicate.

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Or, learn how to contribute.

Still need help?

Ask the GitHub community

Contact support

Working with advanced formatting

Organizing information with tables→

Organizing information with collapsed sections→

Creating and highlighting code blocks→

Autolinked references and URLs→

Attaching files→

Creating a permanent link to a code snippet→

Using keywords in issues and pull requests→

Did this doc help you?

Help us make these docs great!

Still need help?