Webinar

“Digging into Gatsby 5’s Slice API” Register now

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

Edit this page on GitHub
© 2022 Gatsby, Inc.