Skip to content

Commit

Permalink
Update documentation for the resolve option
Browse files Browse the repository at this point in the history
Markdown doesn’t resolve images. Renderers do.
  • Loading branch information
remcohaszing committed Mar 29, 2024
1 parent 6227bb9 commit 5050052
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,9 +115,10 @@ The default export is a [rehype](https://github.com/rehypejs/rehype) plugin.
- `elementAttributeNameCase` (`'html' | 'react'`): The casing to use for attribute names. This
should match the elementAttributeNameCase value passed to MDX. (Default: `'react'`)
- `resolve` (`boolean`): By default imports are resolved relative to the markdown file. This matches
default markdown behaviour. If this is set to false, this behaviour is removed and URLs are no
longer processed. This allows to import images from `node_modules`. If this is disabled, local
images can still be imported by prepending the path with `./.`. (Default: `true`).
behaviour of places that render the markdown, such as GitHub. If this is set to false, this
behaviour is removed and URLs are no longer processed. This allows to import images from
`node_modules`. If this is disabled, local images can still be imported by prepending the path
with `./.`. (Default: `true`).

## Compatibility

Expand Down

0 comments on commit 5050052

Please sign in to comment.