Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

  • Gatsbyjs.com
    Gatsbyjs.com
  • Gatsby Cloud
    Gatsby Cloud
  • Documentation
    Documentation
  • 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
    • v3

      • v4 (beta)

        v4 (beta)

      • v3

        v3

      • v2

        v2

      • v1

        v1

HomeContributingDocs ContributionsDocs StructurePlugin READMEs
Docs Structure

How to Write a Plugin README

Table of Contents

  • Near-perfect example of a plugin README

A plugin README is like a Reference Guide for a specific plugin. It should describe what the plugin does, how to install and configure it, and how to use it in your site.

Near-perfect example of a plugin README

gatsby-source-filesystem

Edit this page on GitHub

Previous

How to Write a Tutorial

Next

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

Contributing

  • Introduction
  • Gatsby's Governance Model
  • Code of Conduct
  • How to Contribute
  • Code Contributions
  • Docs Contributions
    • Docs Writing Process
    • Gatsby Style Guide
    • Docs Structure
      • How to Write a How-To Guide
      • How to Write a Reference Guide
      • How to Write a Conceptual Guide
      • How to Write a Tutorial
      • How to Write a Plugin README
      • How to Write a Starter README
    • Translating the Gatsby Documentation
  • Blog Contributions
  • Community