Markdown renderer for react-native, with CommonMark spec support + adds syntax extensions & sugar (URL autolinking, typographer).
npm install react-native-markdown-rendererIs 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.
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. Because this markdown-renderer uses markdown-it as its base it also supports all its plugins and subsequent extra language support.
| [] | react | react-native | version |
| -- | ----- | ------------ | ------- |
| v | 16.2 | 0.50.4 | 3.0.0 |
| v | 16.0.0-alpha.12 | 0.45.1 | 2.0.5 |
| v | 16.0.0-alpha.6 | 0.44.0 | 2.0.5 |
| x | 15.x | ^0.46.4 | 2.0.5 |
#### npm
``npm`
npm install -S react-native-markdown-renderer`
#### yarnnpm`
yarn add react-native-markdown-renderer
See WIKI for examples and documentation
---
__Advertisement :)__
- __pica__ - high quality and fast image
resize in browser.
- __babelfish__ - developer friendly
i18n with plurals support and easy syntax.
You will like those projects!
---
___
---
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'
This is bold text
__This is bold text__
This is italic text
_This is italic text_
~~Strikethrough~~
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
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
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));
``
| 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. |
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
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"