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.
v2.1.0
- We are going to switch to a type based rule system instead of a html tags. Rules are currently based off html tags "a,h1,h2,h3,h4,ul,li etc." this will change to "anchor, heading1, bullet_list, bullet_list_item" This makes it a lot easier to add extra syntax features through plugins.
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
- Unordered
- foo
- 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.
This renderer, supports the ability extend the current CommonMark A+ spec.
For example:
- checkboxes: [ ] Not Checked [x] Checked https://www.npmjs.com/package/markdown-it-checkbox
- Video Embeds:
@[youtube](dQw4w9WgXcQ)
https://www.npmjs.com/package/markdown-it-video
And a lot more, the list of community created plugins to extends the language are endless. But be carefull add a plugin is easy, creating a rule for it is not. Currently the astRenderer and rules are based off html tags. This makes it especially hard when adding stuff like checkbox or Video Embeds that are grouped under input, label and a tag.
Version 2.1.0 will switch this around and move the rules from tags to type. So a * list
was a "li"
in the rules becomes a "bullet_list_item".
Checkbox was a "input" with no wrapper and will now move to "checkbox". This change will help to make support for plugins a lot easier
[] | 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.
add styleSheet supportadd plugin supportadd support for seperate rules- add styleSheet inheritance support
npm install -S react-native-markdown-renderer
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
- Marker character change forces new list start:
- Very easy!
Ordered
-
Lorem ipsum dolor sit amet
-
Consectetur adipiscing elit
-
Integer molestie lorem at massa
-
You can use sequential numbers...
-
...or keep all the numbers as
1.
Start numbering with offset:
- foo
- 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
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
With a reference later in the document defining the URL location: