react-native-markdown-renderer
Version:
Markdown renderer for react-native, with CommonMark spec support + adds syntax extensions & sugar (URL autolinking, typographer).
221 lines (139 loc) • 4.92 kB
Markdown
# React Native Markdown Renderer [](https://badge.fury.io/js/react-native-markdown-renderer) [](https://snyk.io/test/github/mientjan/react-native-markdown-renderer)
Is a 100% compatible CommonMark renderer, a react-native markdown renderer done right. This is __not__
a web-view markdown renderer but a renderer that uses native components for all its elements. These components can be overwritten when needed as seen in the examples.
### Quick links
- [Documentation](https://github.com/mientjan/react-native-markdown-renderer/wiki/)
- [Examples](https://github.com/mientjan/react-native-markdown-renderer/wiki/Examples)
### Syntax Support
To give a summary of the supported syntax react-native-markdown-renderer supports.
- Tables
- Heading 1 > 6
- Horizontal Rules
- Typographic replacements
- Emphasis ( **bold**, *italic*, ~~strikethrough~~ )
- Blockquotes
- Lists
- Ordered
57. Unordered
2. foo
3. bar
- Code Blocks
- Syntax highlighting
- Links
- 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 |
| ---- | ---- | ------- |
| v | 16.0.0-alpha.12 | 0.45.1 |
| v | 16.0.0-alpha.6 | 0.44.0 |
| x | 15.x | ^0.46.4 |
``` // 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:
#### npm
```npm
npm install -S react-native-markdown-renderer
```
#### yarn
```npm
yarn add react-native-markdown-renderer
```
See [WIKI](https://github.com/mientjan/react-native-markdown-renderer/wiki/) for examples and documentation
---
# Syntax Support
__Advertisement :)__
- __[pica](https://nodeca.github.io/pica/demo/)__ - high quality and fast image
resize in browser.
- __[babelfish](https://github.com/nodeca/babelfish/)__ - developer friendly
i18n with plurals support and easy syntax.
You will like those projects!
---
# h1 Heading 8-)
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading
### Horizontal Rules
___
---
### 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'
## 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
- Nulla volutpat aliquam velit
+ Very easy!
Ordered
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`
Start numbering with offset:
57. foo
1. 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](http://dev.nodeca.com)
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
## Images
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"