This version of GitHub Enterprise Server was discontinued on 2024-01-04. 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 Server. For help with the upgrade, contact GitHub Enterprise support.

Writing for GitHub Docs

Learn about writing for GitHub Docs.

Important

Articles in the "Contributing to GitHub Docs" section refer to the documentation itself and are a resource for GitHub staff and open source contributors.

About GitHub's documentation philosophy
Writing content to be translated
Content design principles
Versioning documentation
Using Markdown and Liquid in GitHub Docs
Using YAML frontmatter
Using videos in GitHub Docs
Creating reusable content
Creating screenshots
Creating diagrams for GitHub Docs
Creating tool switchers in articles
Configuring redirects
Changing an article's title
Annotating code examples
Templates