1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
|
.TH "" "" "" "" ""
.SH NAME
.PP
cmark \- CommonMark parsing, manipulating, and rendering
.SH SIMPLE INTERFACE
.IP
.nf
\f[C]
#define\ CMARK_VERSION\ "0.1"
\f[]
.fi
.PP
Current version of library.
.IP
.nf
\f[C]
char\ *cmark_markdown_to_html(const\ char\ *text,\ int\ len);
\f[]
.fi
.PP
Convert \f[C]text\f[] (assumed to be a UTF\-8 encoded string with length
\f[C]len\f[]) from CommonMark Markdown to HTML, returning a
null\-terminated, UTF\-8\-encoded string.
.SH NODE STRUCTURE
.IP
.nf
\f[C]
typedef\ enum\ {
\ \ \ \ /*\ Block\ */
\ \ \ \ CMARK_NODE_DOCUMENT,
\ \ \ \ CMARK_NODE_BLOCK_QUOTE,
\ \ \ \ CMARK_NODE_LIST,
\ \ \ \ CMARK_NODE_LIST_ITEM,
\ \ \ \ CMARK_NODE_CODE_BLOCK,
\ \ \ \ CMARK_NODE_HTML,
\ \ \ \ CMARK_NODE_PARAGRAPH,
\ \ \ \ CMARK_NODE_HEADER,
\ \ \ \ CMARK_NODE_HRULE,
\ \ \ \ CMARK_NODE_REFERENCE_DEF,
typedef\ enum\ {
\ \ \ \ CMARK_NO_LIST,
\ \ \ \ CMARK_BULLET_LIST,
\ \ \ \ CMARK_ORDERED_LIST
}\ \ cmark_list_type;
typedef\ enum\ {
\ \ \ \ CMARK_PERIOD_DELIM,
\ \ \ \ CMARK_PAREN_DELIM
}\ cmark_delim_type;
\f[]
.fi
.SH CREATING AND DESTORYING NODES
.IP
.nf
\f[C]
cmark_node*
cmark_node_new(cmark_node_type\ type);
void
cmark_node_free(cmark_node\ *node);
cmark_node*
cmark_node_next(cmark_node\ *node);
\f[]
.fi
.SH TREE TRAVERSAL
.IP
.nf
\f[C]
cmark_node*
cmark_node_previous(cmark_node\ *node);
cmark_node*
cmark_node_parent(cmark_node\ *node);
cmark_node*
cmark_node_first_child(cmark_node\ *node);
cmark_node*
cmark_node_last_child(cmark_node\ *node);
\f[]
.fi
.SH ACCESSORS
.IP
.nf
\f[C]
cmark_node_type
cmark_node_get_type(cmark_node\ *node);
const\ char*
cmark_node_get_string_content(cmark_node\ *node);
int
cmark_node_set_string_content(cmark_node\ *node,\ const\ char\ *content);
int
cmark_node_get_header_level(cmark_node\ *node);
int
cmark_node_set_header_level(cmark_node\ *node,\ int\ level);
cmark_list_type
cmark_node_get_list_type(cmark_node\ *node);
int
cmark_node_set_list_type(cmark_node\ *node,\ cmark_list_type\ type);
int
cmark_node_get_list_start(cmark_node\ *node);
int
cmark_node_set_list_start(cmark_node\ *node,\ int\ start);
int
cmark_node_get_list_tight(cmark_node\ *node);
int
cmark_node_set_list_tight(cmark_node\ *node,\ int\ tight);
const\ char*
cmark_node_get_fence_info(cmark_node\ *node);
int
cmark_node_set_fence_info(cmark_node\ *node,\ const\ char\ *info);
const\ char*
cmark_node_get_url(cmark_node\ *node);
int
cmark_node_set_url(cmark_node\ *node,\ const\ char\ *url);
const\ char*
cmark_node_get_title(cmark_node\ *node);
int
cmark_node_set_title(cmark_node\ *node,\ const\ char\ *title);
int
cmark_node_get_start_line(cmark_node\ *node);
int
cmark_node_get_start_column(cmark_node\ *node);
int
cmark_node_get_end_line(cmark_node\ *node);
\f[]
.fi
.SH TREE MANIPULATION
.IP
.nf
\f[C]
void
cmark_node_unlink(cmark_node\ *node);
int
cmark_node_insert_before(cmark_node\ *node,\ cmark_node\ *sibling);
int
cmark_node_insert_after(cmark_node\ *node,\ cmark_node\ *sibling);
int
cmark_node_prepend_child(cmark_node\ *node,\ cmark_node\ *child);
int
cmark_node_append_child(cmark_node\ *node,\ cmark_node\ *child);
\f[]
.fi
.SH PARSING
.IP
.nf
\f[C]
cmark_parser\ *cmark_parser_new();
void\ cmark_parser_free(cmark_parser\ *parser);
cmark_node\ *cmark_parser_finish(cmark_parser\ *parser);
void\ cmark_parser_feed(cmark_parser\ *parser,\ const\ char\ *buffer,\ size_t\ len);
cmark_node\ *cmark_parse_document(const\ char\ *buffer,\ size_t\ len);
cmark_node\ *cmark_parse_file(FILE\ *f);
\f[]
.fi
.SH RENDERING
.IP
.nf
\f[C]
char\ *cmark_render_ast(cmark_node\ *root);
char\ *cmark_render_html(cmark_node\ *root);
\f[]
.fi
.SH AUTHORS
.PP
John MacFarlane, Vicent Marti, Kārlis Gaņģis, Nick Wellnhofer.
|
