DESIGN

Using universal page templates to build sites faster: Join us next Tuesday

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 Gatsby Cloud!
Edit this page on GitHub
© 2023 Gatsby, Inc.