These are the docs for v2, which has an open maintenance window until April 1, 2021. View the v3 docs.

  • Gatsbyjs.com
    Gatsbyjs.com
  • Gatsby Cloud
    Gatsby Cloud
  • Support
    Support
  • Contact
    Contact
  • Log in
    Log in
docs
    • Tutorial
      Tutorial
    • How-to Guides
      How-to Guides
    • Reference
      Reference
    • Conceptual Guide
      Conceptual Guide
    • Quick Start
      Quick Start
    • v2

      • v3

        v3

      • v2

        v2

      • v1

        v1

HomeContributingHow to ContributeDocs ContributionsDocs TemplatesStarter READMEs
Docs Templates

How to Write a Starter README

Table of Contents

  • Near-perfect example of a starter README

Near-perfect example of a starter README

Default Starter README

See the issue relating to this stub on GitHub
Edit this page on GitHub

Previous

How to Write a Plugin README

Next

How to Write a Stub
  • Accessibility Statement
  • Code of Conduct
  • Logo & Assets
  • Privacy Policy

Contributing

  • Introduction
  • Community
  • Code of Conduct
  • Gatsby Style Guide
  • Translating the Gatsby Documentation
  • How to Contribute
    • How to File an Issue
    • How to Make a Reproducible Test Case
    • How to Open a Pull Request
    • How to Label an Issue
    • Triaging GitHub Issues
    • Managing Pull Requests
    • Docs Contributions
      • Docs Writing Process
      • Docs Templates
        • How to Write a Reference Guide
        • How to Write a Recipe
        • How to Write a Tutorial
        • How to Write a Plugin README
        • How to Write a Starter README
      • How to Write a Stub
      • Stub List
    • Blog Contributions
    • Code Contributions
    • Community Contributions
    • Docs & Blog Components
  • RFC Process
  • Gatsby's Governance Model