Update README.md

Adding explanation about available option `offsetY` to solve issue gatsbyjs#5061 Signed-off-by: Robin Cussol <[email protected]>
RobinCsl · May 3, 2018 · 892ec08 · 892ec08
1 parent 129c6b8
commit 892ec08
Showing 1 changed file with 25 additions and 0 deletions.
diff --git 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`,
+            },
+          }
+        ],
+      },
+    },
+  ],
+};
+```