@@ -19,126 +19,126 @@ See [tools built with remark »](https://github.com/wooorm/remark/blob/master/do
19
19
20
20
## List of Plugins
21
21
22
- * [ ben-eb/remark-autolink-headings] ( https://github.com/ben-eb/remark-autolink-headings )
22
+ * [ ` ben-eb/remark-autolink-headings ` ] ( https://github.com/ben-eb/remark-autolink-headings )
23
23
— Automatically add GitHub style links to headings;
24
24
25
- * [ wooorm/remark-comment-config] ( https://github.com/wooorm/remark-comment-config )
25
+ * [ ` wooorm/remark-comment-config ` ] ( https://github.com/wooorm/remark-comment-config )
26
26
— Set settings with comments during runtime;
27
27
28
- * [ hughsk/remark-contributors] ( https://github.com/hughsk/remark-contributors )
28
+ * [ ` hughsk/remark-contributors ` ] ( https://github.com/hughsk/remark-contributors )
29
29
— Inject a given list of contributors into a table in a document;
30
30
31
- * [ eush77/remark-defsplit] ( https://github.com/eush77/remark-defsplit )
32
- — Extract inline link/ image destinations as separate definitions;
31
+ * [ ` eush77/remark-defsplit ` ] ( https://github.com/eush77/remark-defsplit )
32
+ — Extract inline link and image destinations as separate definitions;
33
33
34
- * [ wooorm/remark-github] ( https://github.com/wooorm/remark-github )
34
+ * [ ` wooorm/remark-github ` ] ( https://github.com/wooorm/remark-github )
35
35
— Auto-link references like in GitHub issues, PRs, and comments;
36
36
37
- * [ ben-eb/remark-highlight.js] ( https://github.com/ben-eb/remark-highlight.js )
37
+ * [ ` ben-eb/remark-highlight.js ` ] ( https://github.com/ben-eb/remark-highlight.js )
38
38
— Highlight code blocks in Markdown files with
39
39
[ highlight.js] ( https://github.com/isagalaev/highlight.js ) ;
40
40
41
- * [ wooorm/remark-html] ( https://github.com/wooorm/remark-html )
41
+ * [ ` wooorm/remark-html ` ] ( https://github.com/wooorm/remark-html )
42
42
— Compile Markdown to HTML documents;
43
43
44
- * [ wooorm/remark-inline-links] ( https://github.com/wooorm/remark-inline-links )
44
+ * [ ` wooorm/remark-inline-links ` ] ( https://github.com/wooorm/remark-inline-links )
45
45
— Transform references and definitions into normal links and images;
46
46
47
- * [ wooorm/remark-license] ( https://github.com/wooorm/remark-license )
47
+ * [ ` wooorm/remark-license ` ] ( https://github.com/wooorm/remark-license )
48
48
— Add a license section;
49
49
50
- * [ wooorm/remark-lint] ( https://github.com/wooorm/remark-lint )
50
+ * [ ` wooorm/remark-lint ` ] ( https://github.com/wooorm/remark-lint )
51
51
— Markdown code style linter;
52
52
53
- * [ wooorm/remark-man] ( https://github.com/wooorm/remark-man )
53
+ * [ ` wooorm/remark-man ` ] ( https://github.com/wooorm/remark-man )
54
54
— Compile Markdown to Man pages (roff);
55
55
56
- * [ ben-eb/remark-midas] ( https://github.com/ben-eb/remark-midas )
56
+ * [ ` ben-eb/remark-midas ` ] ( https://github.com/ben-eb/remark-midas )
57
57
— Highlight CSS in Markdown files with [ midas] ( https://github.com/ben-eb/midas ) ;
58
58
59
- * [ eush77/remark-normalize-headings] ( https://github.com/eush77/remark-normalize-headings )
59
+ * [ ` eush77/remark-normalize-headings ` ] ( https://github.com/eush77/remark-normalize-headings )
60
60
— Make sure there is no more than a single top-level heading in the document
61
61
62
- * [ wooorm/remark-range] ( https://github.com/wooorm/remark-range )
62
+ * [ ` wooorm/remark-range ` ] ( https://github.com/wooorm/remark-range )
63
63
— Add range information;
64
64
65
- * [ mapbox/remark-react] ( https://github.com/mapbox/remark-react )
65
+ * [ ` mapbox/remark-react ` ] ( https://github.com/mapbox/remark-react )
66
66
— Compile Markdown to [ React] ( https://github.com/facebook/react ) ;
67
67
68
- * [ wooorm/remark-reference-links] ( https://github.com/wooorm/remark-reference-links )
68
+ * [ ` wooorm/remark-reference-links ` ] ( https://github.com/wooorm/remark-reference-links )
69
69
— Transform links and images into references and definitions;
70
70
71
- * [ wooorm/remark-retext] ( https://github.com/wooorm/remark-retext )
71
+ * [ ` wooorm/remark-retext ` ] ( https://github.com/wooorm/remark-retext )
72
72
— [ retext] ( https://github.com/wooorm/retext ) support;
73
73
74
- * [ wooorm/remark-slug] ( https://github.com/wooorm/remark-slug )
74
+ * [ ` wooorm/remark-slug ` ] ( https://github.com/wooorm/remark-slug )
75
75
— Add slugs to headings;
76
76
77
- * [ wooorm/remark-strip-badges] ( https://github.com/wooorm/remark-strip-badges )
77
+ * [ ` wooorm/remark-strip-badges ` ] ( https://github.com/wooorm/remark-strip-badges )
78
78
— Remove badges (such as ` shields.io ` );
79
79
80
- * [ eush77/remark-squeeze-paragraphs] ( https://github.com/eush77/remark-squeeze-paragraphs )
80
+ * [ ` eush77/remark-squeeze-paragraphs ` ] ( https://github.com/eush77/remark-squeeze-paragraphs )
81
81
— Remove empty paragraphs;
82
82
83
- * [ denysdovhan/remark-textr] ( https://github.com/denysdovhan/remark-textr )
84
- — [ Textr] ( https://github.com/shuvalov-anton/textr ) , a modular typographic
83
+ * [ ` denysdovhan/remark-textr ` ] ( https://github.com/denysdovhan/remark-textr )
84
+ — [ ` Textr ` ] ( https://github.com/shuvalov-anton/textr ) , a modular typographic
85
85
framework;
86
86
87
- * [ wooorm/remark-toc] ( https://github.com/wooorm/remark-toc )
87
+ * [ ` wooorm/remark-toc ` ] ( https://github.com/wooorm/remark-toc )
88
88
— Generate a Table of Contents (TOC) for Markdown files;
89
89
90
- * [ eush77/remark-unlink] ( https://github.com/eush77/remark-unlink )
90
+ * [ ` eush77/remark-unlink ` ] ( https://github.com/eush77/remark-unlink )
91
91
— Remove all links, references and definitions;
92
92
93
- * [ wooorm/remark-usage] ( https://github.com/wooorm/remark-usage )
93
+ * [ ` wooorm/remark-usage ` ] ( https://github.com/wooorm/remark-usage )
94
94
— Add a usage example to your readme;
95
95
96
- * [ wooorm/remark-validate-links] ( https://github.com/wooorm/remark-validate-links )
96
+ * [ ` wooorm/remark-validate-links ` ] ( https://github.com/wooorm/remark-validate-links )
97
97
— Validate links point to existing headings and files;
98
98
99
- * [ wooorm/remark-vdom] ( https://github.com/wooorm/remark-vdom )
99
+ * [ ` wooorm/remark-vdom ` ] ( https://github.com/wooorm/remark-vdom )
100
100
— Compile Markdown to [ VDOM] ( https://github.com/Matt-Esch/virtual-dom/ ) ;
101
101
102
- * [ wooorm/remark-yaml] ( https://github.com/wooorm/remark-yaml )
102
+ * [ ` wooorm/remark-yaml ` ] ( https://github.com/wooorm/remark-yaml )
103
103
— Parse and stringify YAML code blocks;
104
104
105
- * [ wooorm/remark-yaml-config] ( https://github.com/wooorm/remark-yaml-config )
105
+ * [ ` wooorm/remark-yaml-config ` ] ( https://github.com/wooorm/remark-yaml-config )
106
106
— Set settings with YAML during runtime;
107
107
108
108
## List of Utilities
109
109
110
110
Although not ** remark** plug-ins, the following projects are useful when
111
111
working with the AST ([ ** mdast** ] ( https://github.com/wooorm/mdast ) ):
112
112
113
- * [ wooorm/mdast-util-definitions] ( https://github.com/wooorm/mdast-util-definitions )
113
+ * [ ` wooorm/mdast-util-definitions ` ] ( https://github.com/wooorm/mdast-util-definitions )
114
114
— Find definition nodes;
115
115
116
- * [ wooorm/mdast-util-escape] ( https://github.com/wooorm/mdast-util-escape )
116
+ * [ ` wooorm/mdast-util-escape ` ] ( https://github.com/wooorm/mdast-util-escape )
117
117
— Escape text to be inserted into a node;
118
118
119
- * [ wooorm/mdast-util-heading-range] ( https://github.com/wooorm/mdast-util-heading-range )
119
+ * [ ` wooorm/mdast-util-heading-range ` ] ( https://github.com/wooorm/mdast-util-heading-range )
120
120
— Markdown heading as ranges;
121
121
122
- * [ wooorm/mdast-util-heading-style] ( https://github.com/wooorm/mdast-util-heading-style )
122
+ * [ ` wooorm/mdast-util-heading-style ` ] ( https://github.com/wooorm/mdast-util-heading-style )
123
123
— Get the style of a heading (` "atx" ` , ` "atx-closed" ` , or ` "setext" ` );
124
124
125
- * [ anandthakker/mdast-util-inject] ( https://github.com/anandthakker/mdast-util-inject )
125
+ * [ ` anandthakker/mdast-util-inject ` ] ( https://github.com/anandthakker/mdast-util-inject )
126
126
— Inject one AST into another at a specified heading, keeping heading
127
127
structure intact;
128
128
129
- * [ wooorm/mdast-util-position] ( https://github.com/wooorm/mdast-util-position )
129
+ * [ ` wooorm/mdast-util-position ` ] ( https://github.com/wooorm/mdast-util-position )
130
130
— Get the position of nodes;
131
131
132
- * [ wooorm/mdast-util-to-string] ( https://github.com/wooorm/mdast-util-to-string )
132
+ * [ ` wooorm/mdast-util-to-string ` ] ( https://github.com/wooorm/mdast-util-to-string )
133
133
— Get the plain text content of a node.
134
134
135
- * [ eush77/mdast-normalize-headings] ( https://github.com/eush77/mdast-normalize-headings )
135
+ * [ ` eush77/mdast-normalize-headings ` ] ( https://github.com/eush77/mdast-normalize-headings )
136
136
— Make sure there is no more than a single top-level heading in the document
137
137
138
- * [ eush77/mdast-squeeze-paragraphs] ( https://github.com/eush77/mdast-squeeze-paragraphs )
138
+ * [ ` eush77/mdast-squeeze-paragraphs ` ] ( https://github.com/eush77/mdast-squeeze-paragraphs )
139
139
— Remove empty paragraphs;
140
140
141
- * [ wooorm/mdast-zone] ( https://github.com/wooorm/mdast-zone )
141
+ * [ ` wooorm/mdast-zone ` ] ( https://github.com/wooorm/mdast-zone )
142
142
— HTML comments as ranges or markers.
143
143
144
144
In addition, see [ ` unist ` ] ( https://github.com/wooorm/unist#unist-node-utilties )
@@ -164,8 +164,8 @@ It is recommended to publish a plugin as an
164
164
[ npm module] ( https://docs.npmjs.com/getting-started/publishing-npm-packages ) .
165
165
166
166
You should pick a name prefixed by ` "remark-" ` , valid examples are
167
- [ ** remark-toc** ] ( https://www.npmjs.com/package/remark-toc ) or
168
- [ ** remark-yaml-config** ] ( https://www.npmjs.com/package/remark-yaml-config ) .
167
+ [ ` remark-toc ` ] ( https://www.npmjs.com/package/remark-toc ) or
168
+ [ ` remark-yaml-config ` ] ( https://www.npmjs.com/package/remark-yaml-config ) .
169
169
The reasoning here is that they can be used on the CLI without this prefix,
170
170
but can still be meaningful. For example, ` lint ` was not available, but instead
171
171
of opting for ` liiint ` or some other weird form, using ` remark-lint ` ensured a
0 commit comments