From 892ec08c0b1f458ce688f1f8d5ad8b97e7481b85 Mon Sep 17 00:00:00 2001
From: Robin Cussol <RobinCsl@users.noreply.github.com>
Date: Thu, 3 May 2018 14:31:12 +0200
Subject: [PATCH] Update README.md

Adding explanation about available option `offsetY` to solve issue #5061
Signed-off-by: Robin Cussol <me@robincussol.com>
---
 .../gatsby-remark-autolink-headers/README.md  | 25 +++++++++++++++++++
 1 file changed, 25 insertions(+)

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`,
+            },
+          }
+        ],
+      },
+    },
+  ],
+};
+```