Skip to content

Commit

Permalink
updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mientjan committed Jan 19, 2018
1 parent dd6bdc4 commit 9226917
Show file tree
Hide file tree
Showing 5 changed files with 25 additions and 5 deletions.
4 changes: 0 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ To give a summary of the supported syntax react-native-markdown-renderer support
- Images
- Plugins for **extra** syntax support, [see plugins](https://www.npmjs.com/browse/keyword/markdown-it-plugin). Because this markdown-renderer uses markdown-it as its base it also supports all its plugins and subsequent extra language support.


### Tested on:

| [] | react | react-native | version |
Expand All @@ -40,13 +39,10 @@ To give a summary of the supported syntax react-native-markdown-renderer support
| v | 16.0.0-alpha.6 | 0.44.0 | 2.0.5 |
| x | 15.x | ^0.46.4 | 2.0.5 |

``` // react 15 seems to break with expo.```

### Todo
- ~~add styleSheet support~~
- ~~add plugin support~~
- ~~add support for seperate rules~~
- add styleSheet inheritance support

### How to:

Expand Down
2 changes: 2 additions & 0 deletions doc/example/simple-with-custom-renderer.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Simple Implementation with custom styles

docs for v3.0.0

So to describe what i customized
- Heading1 has a **fontSize** of 32, **backgroundColor** black and a **color** white.
- all headers have a **border** at the bottom, of width 1 with a black color.
Expand Down
2 changes: 2 additions & 0 deletions doc/example/simple-with-custom-rules.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Simple Implementation with custom Rules

docs for v3.0.0

So to describe what i customized
- header1 will always look like ```[ h1 Heading 8-)]```
- header2 will always look like ```[ h2 Heading 8-)]```
Expand Down
2 changes: 2 additions & 0 deletions doc/example/simple-with-custom-styles.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Simple Implementation with custom styles

docs for v3.0.0

So to describe what i customized
- Heading1 has a **fontSize** of 32, **backgroundColor** black and a **color** white.
- all headers have a **border** at the bottom, of width 1 with a black color.
Expand Down
20 changes: 19 additions & 1 deletion doc/example/simple.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Basic Implementation

docs for v3.0.0

```js
import react from 'react';
import {PureComponent} from 'react-native';
Expand All @@ -25,4 +27,20 @@ export default class Page extends PureComponent {
);
}
}
```
```


- updating docs Mient-jan Stelling 1/19/18, 13:00
- updating readme Mient-jan Stelling 1/19/18, 12:59
- Merge branch 'release/3.0.0' Mient-jan Stelling 1/19/18, 12:55
- fixed issue where headers would now break to new line. Mient-jan Stelling 1/19/18, 12:54
- fixed issue where images would not render. Mient-jan Stelling 1/19/18, 12:33
- fixed issue where you could not set a general fontSize fo all copy. #17 Mient-jan Stelling 1/19/18, 12:06
- adding small function so example wont break when starting it. Mient-jan Stelling 1/18/18, 18:55
- updating to 3.0.0 because of breaking changes Mient-jan Stelling 1/18/18, 18:48
- updating package.json to new react and react-native versions Mient-jan Stelling 1/18/18, 18:47
- refactoring code so it will be easier to add plugins Mient-jan Stelling 1/18/18, 18:46
- updating example code base Mient-jan Stelling 1/18/18, 18:39
- adding watcher, for better development of component Mient-jan Stelling 1/18/18, 18:36
- converting to new rule names, ul = bullet_list li = ordered_list a = link br = softbreak h1 <> h6 = heading1 <> heading6 Mient-jan Stelling 1/16/18, 14:13
- adding type convert function for better support of new of writing tags. Mient-jan Stelling 1/16/18, 11:57

0 comments on commit 9226917

Please sign in to comment.