Skip to content

Commit d6596ef

Browse files
authored
Update README.md
1 parent 0a21ec2 commit d6596ef

File tree

1 file changed

+1
-3
lines changed

1 file changed

+1
-3
lines changed

README.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,9 @@ the output will look like this:
9393
`options` (optional)
9494

9595
* `options.mdx` (`boolean`, default: true) if you use mdx-js leave it to true, if you use markdown set it to false
96-
* `options.containerTagName` (`string`, default: 'aside') chose an element for the container that is around the toc, can by any html element you want, a `div`, a `section` ...
96+
* `options.containerTagName` (`string`, default: 'aside') chose an element for the container that is around the toc, can be any HTML element you want, a `div`, a `section` ...
9797
* `options.hasContainer` (`boolean`, default: true) by default the toc is in a container, set to false to not use a container
9898

99-
let's the plugin know if you are using mdx (mdx:true) or markdown (mdx: false)
100-
10199
`options.*`
102100

103101
this plugin uses [mdast-util-toc](https://github.com/syntax-tree/mdast-util-toc) under the hood, to generate the toc, which means all **mdast-util-toc** options are supported as well:

0 commit comments

Comments
 (0)