Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

How to Write 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

Start building today on Netlify!
Edit this page on GitHub
© 2023 Gatsby, Inc.