From 285485fb0eca3d0e8e48ca8cc69ee6282f168ffa Mon Sep 17 00:00:00 2001 From: edukisto <52005215+edukisto@users.noreply.github.com> Date: Mon, 28 Dec 2020 22:13:25 +0300 Subject: [PATCH] Update README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index b574c05..d8b2c62 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,11 @@ npm i --save gatsby-remark-table-of-contents ``` ### Global Configuration + Global configurations should be set in `gatsby-config.js`. +**Important**: if you’re also using `gatsby-remark-prismjs` make sure that both `gatsby-remark-autolink-headers` and `gatsby-remark-table-of-contents` are listed **before** `gatsby-remark-prismjs`. + ```js module.exports = ({ root }) => ({ plugins: [ @@ -51,6 +54,7 @@ module.exports = ({ root }) => ({ ``` ## Use + Generate a table of contents: ````md @@ -74,6 +78,7 @@ class-name: "table-of-contents" ```` ## Options + ### `exclude` `string? | array?` — default: `''`