Skip to content

Commit

Permalink
docs: describe composable returns
Browse files Browse the repository at this point in the history
  • Loading branch information
Sandros94 committed Feb 25, 2024
1 parent 0c7c510 commit c6037bd
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,19 @@ In order to use markdown-it plugins you have to create your own `NuxtMarkdown` c

That's it! You can now use `nuxt-markdown-render` module in your Nuxt app ✨

### `useNuxtMarkdown` exports

The following are the available exports for `useNuxtMarkdown` composable.

```ts
const {
config, // configs in use, currently for debuging purposes
content, // rendered content from markdown-it
md, // main parser/renderer
rendered, // rendered vue component based on `content`
} = useNuxtMarkdown(source, configs)
```

## Development

```bash
Expand Down

0 comments on commit c6037bd

Please sign in to comment.