Skip to content

Commit a95b145

Browse files
bump version
1 parent 8f22536 commit a95b145

File tree

3 files changed

+32
-3
lines changed

3 files changed

+32
-3
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [0.2.0] - 2020-04-17
6+
7+
### Added
8+
9+
- Ability to extend defaults. Allow users to pass in an object as parameter and extend defaults.

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ For example, when you want to render level 2 heading component, it is rendering:
1515
### Install
1616

1717
```sh
18-
$ yarn add @chakra-ui/core
18+
$ yarn add @chakra-ui/core chakra-ui-markdown-renderer
1919
# or
20-
$ npm install --save @chakra-ui/core
20+
$ npm install --save @chakra-ui/core chakra-ui-markdown-renderer
2121
```
2222

2323
### Usage
@@ -31,3 +31,23 @@ import ChakraUIRenderer from "chakra-ui-markdown-renderer";
3131
escapeHtml={false}
3232
/>;
3333
```
34+
35+
### Extending Defaults
36+
37+
```jsx
38+
import ChakraUIRenderer, { defaults } from 'chakra-ui-markdown-renderer';
39+
40+
const newTheme = {
41+
paragraph: props => {
42+
const { children } = props;
43+
return <Text mb={2} fontSize={'12px'}>{children}</Text>;
44+
},
45+
...defaults
46+
}
47+
48+
<ReactMarkdown
49+
renderers={ChakraUIRenderer(newTheme)}
50+
source={decode(recipeDescription)}
51+
escapeHtml={false}
52+
/>
53+
```

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "chakra-ui-markdown-renderer",
33
"main": "dist/index.js",
4-
"version": "0.1.2",
4+
"version": "0.2.0",
55
"private": false,
66
"license": "MIT",
77
"files": [

0 commit comments

Comments
 (0)