We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

This version of GitHub Enterprise was discontinued on 2023-03-15. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise. For help with the upgrade, contact GitHub Enterprise support.

Getting started with writing and formatting on GitHub

You can use simple features to format your comments and interact with others in issues, pull requests, and wikis on GitHub.

Quickstart for writing on GitHub
Learn advanced formatting features by creating a README for your GitHub profile.
About writing and formatting on GitHub
GitHub combines a syntax for formatting text called GitHub Flavored Markdown with a few unique writing features.
Basic writing and formatting syntax
Create sophisticated formatting for your prose and code on GitHub with simple syntax.