`
# h1 Heading 8-)
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
`

| iOS | Android
| --- | ---
| |

`
Some text above
___

Some text in the middle

---

Some text below
`

| iOS | Android
| --- | ---
| |

`
This is bold text

__This is bold text__

This is italic text

_This is italic text_

~~Strikethrough~~
`

| iOS | Android
| --- | ---
| |

`
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
`

| iOS | Android
| --- | ---
| |

`
Unordered

+ Create a list by starting a line with +, -, or *
+ Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
* Ac tristique libero volutpat at
+ Facilisis in pretium nisl aliquet. This is a very long list item that will surely wrap onto the next line.
- Nulla volutpat aliquam velit
+ Very easy!

Ordered

1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit. This is a very long list item that will surely wrap onto the next line.
3. Integer molestie lorem at massa

Start numbering with offset:

57. foo
58. bar
`

| iOS | Android
| --- | ---
| |



`
Inline \code\

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code


Block code "fences"

\\\
Sample text here...
\\\

Syntax highlighting

\\\ js
var foo = function (bar) {
return bar++;
};

console.log(foo(5));
\\\
`

| iOS | Android
| --- | ---
| |

`
| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |

Right aligned columns

| Option | Description |
| ------:| -----------:|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
`

| iOS | Android
| --- | ---
| |

`
link text

link with title

Autoconverted link https://www.google.com (enable linkify to see)
`

| iOS | Android
| --- | ---
| |

`
!Minion
!Stormtroopocat

Like links, Images also have a footnote style syntax

![Alt text][id]

With a reference later in the document defining the URL location:

[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"
`

| iOS | Android
| --- | ---
| |

`
Enable typographer option to see result.

(c) (C) (r) (R) (tm) (TM) (p) (P) +-

test.. test... test..... test?..... test!....

!!!!!! ???? ,, -- ---

"Smartypants, double quotes" and 'single quotes'
`

| iOS | Android
| --- | ---
| |

Identify the new components and integrate the plugin with a rendered component. We can use the debugPrintTree property to see what rules we are rendering:


`jsx
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar } from 'react-native';

import Markdown, { MarkdownIt }from '@ronradtke/react-native-markdown-display';
import blockEmbedPlugin from 'markdown-it-block-embed';

const markdownItInstance =
MarkdownIt({typographer: true})
.use(blockEmbedPlugin, {
containerClassName: "video-embed"
});

const copy =

Some header

@youtube
;

const App: () => React$Node = () => {
return (
<>


contentInsetAdjustmentBehavior="automatic"
style={{height: '100%'}}
>
debugPrintTree
markdownit={markdownItInstance}
>
{copy}




);
};

export default App;

`

In the console, we will see the following rendered tree:

`
body
-heading1
--textgroup
---text
-video
`

With the following error message:

`
Warning, unknown render rule encountered: video. 'unknown' render rule used (by default, returns null - nothing rendered)
`


#### Step 2

We need to create the render rules and styles to handle this new 'video' component


`jsx
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar } from 'react-native';

import Markdown, { MarkdownIt }from '@ronradtke/react-native-markdown-display';
import blockEmbedPlugin from 'markdown-it-block-embed';

const markdownItInstance =
MarkdownIt({typographer: true})
.use(blockEmbedPlugin, {
containerClassName: "video-embed"
});

const copy =

Some header

@youtube
;

const App: () => React$Node = () => {
return (
<>


contentInsetAdjustmentBehavior="automatic"
style={{height: '100%'}}
>
debugPrintTree
markdownit={markdownItInstance}
style={{
video: {
color: 'red',
}
}}
rules={{
video: (node, children, parent, styles) =>{
// examine the node properties to see what video we need to render
console.log(node); // expected output of this is in readme.md below this code snip

return (
Return a video component instead of this text component!
);
}

}}
>
{copy}




);
};

export default App;
`

And all of the video properties needed to render something meaningful are on the node, like this:

`
{type: "video", sourceType: "video", sourceInfo: {…}, sourceMeta: null, block: true, …}
attributes: {}
block: true
children: []
content: ""
index: 1
key: "rnmr_1720a98f540_video"
markup: "@youtube"
sourceInfo:
service: YouTubeService
env: PluginEnvironment {md: MarkdownIt, options: {…}, services: {…}}
name: "youtube"
options:
height: 390
width: 640
serviceName: "youtube"
videoID: "lJIrF4YjHfQ"
videoReference: "lJIrF4YjHfQ"
sourceMeta: null
sourceType: "video"
tokenIndex: 5
type: "video"
`

#### Other Debugging

You can do some additional debugging of what the markdown instance is spitting out like this:

`jsx
import Markdown, { MarkdownIt }from '@ronradtke/react-native-markdown-display';
import blockEmbedPlugin from 'markdown-it-block-embed';

const markdownItInstance =
MarkdownIt({typographer: true})
.use(blockEmbedPlugin, {
containerClassName: "video-embed"
});

const copy =

Some header

@youtube
;

// this shows you the tree that is used by the react-native-markdown-display
const astTree = markdownItInstance.parse(copy, {});
console.log(astTree);

//this contains the html that would be generated - not used by react-native-markdown-display but useful for reference
const html = markdownItInstance.render(copy);
console.log(html);

`

The above code will output something like this:

`
astTree:

(4) [Token, Token, Token, Token]

0: Token {type: "heading_open", tag: "h1", attrs: null, map: Array(2), nesting: 1, …}
1: Token {type: "inline", tag: "", attrs: null, map: Array(2), nesting: 0, …}
2: Token {type: "heading_close", tag: "h1", attrs: null, map: null, nesting: -1, …}
3: Token {type: "video", tag: "div", attrs: null, map: Array(2), nesting: 0, …}

length: 4
`

`
html:

Some header

`
Headings

# h1 Heading 8-)
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading


Horizontal Rules

Some text above
___

Some text in the middle

---

Some text below


Emphasis

This is bold text

__This is bold text__

This is italic text

_This is italic text_

~~Strikethrough~~


Blockquotes

> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.


Lists

Unordered

+ Create a list by starting a line with +, -, or *
+ Sub-lists are made by indenting 2 spaces:
- Marker character change forces new list start:
* Ac tristique libero volutpat at
+ Facilisis in pretium nisl aliquet. This is a very long list item that will surely wrap onto the next line.
- Nulla volutpat aliquam velit
+ Very easy!

Ordered

1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit. This is a very long list item that will surely wrap onto the next line.
3. Integer molestie lorem at massa

Start numbering with offset:

57. foo
58. bar


Code

Inline \code\

Indented code

// Some comments
line 1 of code
line 2 of code
line 3 of code


Block code "fences"

\\\
Sample text here...
\\\

Syntax highlighting

\\\ js
var foo = function (bar) {
return bar++;
};

console.log(foo(5));
\\\


Tables

| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |

Right aligned columns

| Option | Description |
| ------:| -----------:|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |


Links

link text

link with title

Autoconverted link https://www.google.com (enable linkify to see)


Images

!Minion
!Stormtroopocat

Like links, Images also have a footnote style syntax

![Alt text][id]

With a reference later in the document defining the URL location:

[id]: https://octodex.github.com/images/dojocat.jpg "The Dojocat"


Typographic Replacements

Enable typographer option to see result.

(c) (C) (r) (R) (tm) (TM) (p) (P) +-

test.. test... test..... test?..... test!....

!!!!!! ???? ,, -- ---

"Smartypants, double quotes" and 'single quotes'

`

`jsx
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar } from 'react-native';

import Markdown from '@ronradtke/react-native-markdown-display';

const copy =
This is some text which is red because of the body style, which is also really small!

\\\
//This is a code block woooo

const cool = () => {
console.log('????');
};
\\\

and some more small text

This is a h1

this is a h2

$3

export default App;
`

`jsx
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar, StyleSheet } from 'react-native';

import Markdown from '@ronradtke/react-native-markdown-display';

const styles = StyleSheet.create({
heading1: {
fontSize: 32,
backgroundColor: '#000000',
color: '#FFFFFF',
},
heading2: {
fontSize: 24,
},
heading3: {
fontSize: 18,
},
heading4: {
fontSize: 16,
},
heading5: {
fontSize: 13,
},
heading6: {
fontSize: 11,
}
});

const copy =

h1 Heading 8-)

h2 Heading 8-)

$3

| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
;

const App: () => React$Node = () => {
return (
<>


contentInsetAdjustmentBehavior="automatic"
style={{height: '100%'}}
>
style={styles}
>
{copy}




);
};

export default App;
`

`jsx
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar, Text } from 'react-native';

import Markdown from '@ronradtke/react-native-markdown-display';

const rules = {
heading1: (node, children, parent, styles) =>

>> H1 TEXT HERE >> "{children}"
,
heading2: (node, children, parent, styles) =>

>> H2 TEXT HERE >> "{children}"
,
heading3: (node, children, parent, styles) =>

>> H3 TEXT HERE >> "{children}"
,
};

const copy =

h1 Heading 8-)

h2 Heading 8-)

$3

| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
;

const App: () => React$Node = () => {
return (
<>


contentInsetAdjustmentBehavior="automatic"
style={{height: '100%'}}
>
rules={rules}
>
{copy}




);
};

export default App;
`

`jsx
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar } from 'react-native';

import Markdown from '@ronradtke/react-native-markdown-display';

const copy = This is a link!;

const onLinkPress = (url) => {
if (url) {
// some custom logic
return false;
}

// return true to open with Linking.openURL
// return false to handle it yourself
return true
}

const App: () => React$Node = () => {
return (
<>


contentInsetAdjustmentBehavior="automatic"
style={{height: '100%'}}
>
onLinkPress={onLinkPress}
>
{copy}




);
};

export default App;
``

You will need to overwrite one or both of link and blocklink, the original defenitions can be found here

Something like this with yourCustomHandlerFunctionOrLogicHere:

`jsx
import React from 'react';
import { SafeAreaView, ScrollView, StatusBar, Text } from 'react-native';

import Markdown from '@ronradtke/react-native-markdown-display';

const copy = This is a link!;

const rules = {
link: (node, children, parent, styles) => {
return (
yourCustomHandlerFunctionOrLogicHere(node.attributes.href) }>
{children}

);
},
};

const App: () => React$Node = () => {
return (
<>


contentInsetAdjustmentBehavior="automatic"
style={{height: '100%'}}
>
rules={rules}
>
{copy}




);
};

export default App;
`