Setting up your environment to work on GitHub Docs - GitHub Docs (original) (raw)

Skip to main content

• Contribute to GitHub Docs/

• Your working environment

• • Best practices for GitHub Docs
  • Documentation philosophy
  • Documentation fundamentals
  • Content design principles
  • Write content to be translated
  • Make content findable
  • Versioning documentation
  • Markdown and Liquid
  • YAML frontmatter
  • Use videos
  • Create reusable content
  • Create screenshots
  • Create diagrams
  • Create tool switchers
  • Configure redirects
  • Change an article's title
  • Annotate code examples
  • Templates
• • 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
• • About contributing
  • Using Git
  • Using the TODOCS placeholder
  • Using the content linter
  • Label reference
• • Working in a codespace
  • Create a local environment
  • Troubleshooting your environment