You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-31Lines changed: 3 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,27 +3,20 @@
3
3
Is a 100% compatible CommonMark renderer, a react-native markdown renderer done right. This is __not__
4
4
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.
5
5
6
-
### Future releases
7
-
**v2.1.0**
8
-
- We are going to switch to a type based rule system instead of a html tags. Rules are currently
9
-
based off html tags "a,h1,h2,h3,h4,ul,li etc." this will change to "anchor, heading1, bullet_list, bullet_list_item"
10
-
This makes it a lot easier to add extra syntax features through plugins.
@@ -35,28 +28,7 @@ To give a summary of the supported syntax react-native-markdown-renderer support
35
28
- Syntax highlighting
36
29
- Links
37
30
- Images
38
-
- Plugins for **extra** syntax support, [see plugins](https://www.npmjs.com/browse/keyword/markdown-it-plugin).
39
-
Because this markdown-renderer uses markdown-it as its base it also supports all its plugins and
40
-
subsequent extra language support.
41
-
42
-
### Plugins, Extending Markdown (common mark A+) language support
43
-
This renderer, supports the ability extend the current CommonMark A+ spec.
44
-
45
-
For example:
46
-
47
-
- checkboxes: [] Not Checked [x] Checked https://www.npmjs.com/package/markdown-it-checkbox
48
-
- Video Embeds: ```@[youtube](dQw4w9WgXcQ)```https://www.npmjs.com/package/markdown-it-video
49
-
50
-
And a lot more, the list of community created plugins to extends the language are endless. But be
51
-
**carefull** add a plugin is easy, creating a rule for it is not. Currently the astRenderer and rules
52
-
are based off html tags. This makes it especially hard when adding stuff like checkbox or Video Embeds
53
-
that are grouped under input, label and a tag.
54
-
55
-
**Version 2.1.0** will switch this around and move the rules from tags to type. So a ```* list``` was a "li"
56
-
in the rules becomes a "bullet_list_item".
57
-
58
-
Checkbox was a "input" with no wrapper and will now move to "checkbox". This change will help to make support
59
-
for plugins a lot easier
31
+
- 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.
0 commit comments