Skip to main content
GitHub Docs
Version:
Free, Pro, & Team
Search GitHub Docs
Contribute to GitHub Docs
/
Your working environment
Home
Contribute to GitHub Docs
Writing for GitHub Docs
Best practices for GitHub Docs
Documentation philosophy
Write content to be translated
Content design principles
Versioning documentation
Markdown and Liquid
YAML frontmatter
Using videos
Create reusable content
Create screenshots
Creating diagrams
Creating tool switchers
Configuring redirects
Change an article's title
Annotating code examples
Templates
Style guide and content model
Style guide
About the content model
Contents of an article
About topics
Conceptual content type
Referential content type
Procedural content type
Troubleshooting content type
Release note content type
Quickstart content type
Tutorial content type
Combining multiple types
Collaborate on GitHub Docs
About contributing
Using Git
Using the TODOCS placeholder
Using the content linter
Label reference
Self review checklist
Your working environment
Working in a codespace
Create a local environment
Troubleshooting your environment
Contribute to GitHub Docs
/
Your working environment
Setting up your environment to work on GitHub Docs
Learn about running the GitHub Docs site locally or in GitHub Codespaces.
Working on GitHub Docs in a codespace
Creating a local environment
Troubleshooting your environment