About writing and formatting on GitHub
Map where GitHub Flavored Markdown applies across issues, PRs, wikis, and README files, then prove each surface with sub-5s gh api checks.
What this covers
About writing and formatting on GitHub is the conceptual overview: Markdown plus GitHub-specific extras like @-mentions, issue/PR references, and emoji. Sibling pages cover syntax and advanced formatting in depth.
GitHub Flavored Markdown
Markdown is plain text with lightweight formatting markers. GitHub extends it as GitHub Flavored Markdown for prose and code site-wide. You can also interact in pull requests and issues with @-mentions, issue and PR references, and emoji. Details live in Basic writing and formatting syntax.
Text formatting toolbar
Every comment field includes a toolbar for bold, italic, headings, links, lists, and GitHub-specific actions such as @-mentions, task lists, and links to issues and pull requests. Use the toolbar when you do not want to memorize syntax; type Markdown when you prefer full control.
Enable a fixed-width font in the editor
A monospace font makes tables and snippets easier to align while editing.
- In the upper-right corner of any page on GitHub, click your profile picture, then click Settings.
- In the left sidebar, click Appearance.
- Under Markdown editor font preference, select Use a fixed-width (monospace) font when editing Markdown.
Further reading
- GitHub Flavored Markdown Spec
- Basic writing and formatting syntax
- Working with advanced formatting
- Quickstart for writing on GitHub
flowchart LR
Editor[Editor Interface] --> Toolbar[Formatting Toolbar]
Editor --> Monospace[Fixed-Width Font Setting]
Toolbar --> Syntax[GitHub Flavored Markdown]
Syntax --> Target[Render across Issues, PRs, and Discussions]