Merge pull request #134 from valeriangalliat/slugify-with-state

Introduce `slugifyWithState` to avoid breaking change with `slugify` second argument

README.md

@@ -118,6 +118,8 @@ const md = require('markdown-it')()
   .use(require('markdown-it-anchor'), { slugify: s => slugify(s) })
 ```
 
+### Custimizing the slugify input
+
 Additionally, if you want to further customize the title that gets
 passed to the `slugify` function, you can do so by customizing the
 `getTokensText` function, that gets the plain text from a list of
@@ -144,6 +146,18 @@ the previous approach with a stock markdown-it, but would also include
 custom tokens added by any of your markdown-it plugins, which might or
 might not be desirable for you. Now you have the option!
 
+### Slugifying with state
+
+If you need access to the markdown-it state from the slugify function,
+e.g. to access `state.env`, you can use `slugifyWithState` instead.
+
+```js
+const md = require('markdown-it')()
+  .use(require('markdown-it-anchor'), {
+    slugifyWithState: (title, state) => `${state.env.id}-${slugify(title)}`
+  })
+```
+
 ## Manually setting the `id` attribute
 
 You might want to explicitly set the `id` attribute of your headings