Skip to content

Commit

Permalink
doc: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
colin.ck committed Jan 3, 2019
1 parent 76b6b65 commit 2d28f18
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Where the property `data` is the JSON string or just a plain JavaScript object.

Lastly, you can add themes stated below.

** Note: if `yourData` is not a plain object, use `circular-json` or other similar tools to preprocess it before pass to `JSONPretty`.**
***Note: if `yourData` is not a plain object, use `circular-json` or other similar tools to preprocess it before passed to `JSONPretty`.***

### Themes

Expand Down Expand Up @@ -98,15 +98,15 @@ Here is an example:
</JSONPretty>
```

*** Note: The default value for property `replacer` is `null`,and `space` is `2`. ***
***Note: The default value for property `replacer` is `null`,and `space` is `2`.***

You can visit the [example](https://github.com/chenckang/react-json-pretty/tree/master/example) to see the details.

### Custom `themeClassName`

Your can also define your custome `themeClassName`, the default value is `__json-pretty__`.

*** Note: this may lead to the usage of default themes provided with css being invalid. ***
***Note: this may lead to the usage of default themes provided with css being invalid.***

```jsx
// The final className will be 'custom-json-pretty'
Expand All @@ -129,7 +129,7 @@ It is also prossible to define a custom theme:

Here is the schema:

```ts
```
{
main?: string,
key?: string,
Expand Down

0 comments on commit 2d28f18

Please sign in to comment.