diff --git a/packages/gatsby-remark-autolink-headers/README.md b/packages/gatsby-remark-autolink-headers/README.md index 514bf1c9e4833..63484418faa82 100644 --- a/packages/gatsby-remark-autolink-headers/README.md +++ b/packages/gatsby-remark-autolink-headers/README.md @@ -23,3 +23,28 @@ module.exports = { ], }; ``` + +## Options + +* `offsetY`: Signed integer, vertical offset value in pixels, e.g. + +```javascript +// In your gatsby-config.js +module.exports = { + plugins: [ + { + resolve: `gatsby-transformer-remark`, + options: { + plugins: [ + { + resolve: `gatsby-remark-autolink-headers`, + options: { + offsetY: `100`, + }, + } + ], + }, + }, + ], +}; +```