Skip to content

Commit 00c69da

Browse files
committed
docs: Update readme
1 parent 3c2b2fc commit 00c69da

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ The quickstart above shows how rendering of markdown can be done for both bot an
8181
**Markdown Renderer** is a lightweight plugin that provides the following features to your chatbot:
8282
- Render markdown in bot chat messages
8383
- Render markdown in user chat messages
84+
- Optionally pass in your own custom markdown component to render markdown your way
8485

8586
### API Documentation
8687

@@ -109,6 +110,7 @@ As you may be able to tell from above, there are 5 configurable sections within
109110
| Configuration Option | Type | Default Value | Description |
110111
|------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
111112
| `autoConfig` | boolean | `true` | Enables automatic configuration of required events for markdown rendering. Recommended to keep as `true`. If set to `false`, you need to configure events manually. |
113+
| `markdownComponent` | React.ComponentType<{ children: React.ReactNode }> | `null` | A React component to wrap around the message's content to customize its styling, layout, or behavior. The component will receive the message's content as its children prop, so you can design it to add custom formatting, animations, or other UI enhancements. If not provided, a default wrapper from **react-markdown** will be used. |
112114

113115
#### Rendering Markdown
114116

0 commit comments

Comments
 (0)