Skip to content

Commit 4837926

Browse files
committed
clarify mdx option needs to be false for markdown
1 parent aa2d4c0 commit 4837926

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ npm i remark-table-of-contents --save-exact
2323

2424
pure markdown example
2525

26-
Note: when using the remark-table-of-contents plugin, you need to set the option **mdx** to **false** which is what this example does
26+
Note: when using the remark-table-of-contents plugin and your content is **markdown** (so when it is NOT MDX), you need to set the option **mdx** to **false** which is what this example does, for a full list of options check out the [options section](#options) below
2727

2828
check out the [readme of the remark example](./examples/simple-remark-example/README.md) for more details about this example, all the source code is located in `examples/simple-remark-example/`
2929

0 commit comments

Comments
 (0)