-
-
Notifications
You must be signed in to change notification settings - Fork 249
/
Copy pathMarkdown.resi
176 lines (143 loc) · 3.78 KB
/
Markdown.resi
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
module P: {
@react.component
let make: (~children: React.element) => React.element
}
// Used for hero like introduction text in
// e.g Doc sections
module Intro: {
@react.component
let make: (~children: React.element) => React.element
}
module Cite: {
@react.component
let make: (~author: option<string>, ~children: React.element) => React.element
}
module Info: {
@react.component
let make: (~children: React.element) => React.element
}
module Warn: {
@react.component
let make: (~children: React.element) => React.element
}
module UrlBox: {
@react.component
let make: (~text: string, ~href: string, ~children: Mdx.MdxChildren.t) => React.element
}
// Used for creating invisible, hoverable <a> anchors for url linking
module Anchor: {
/* let idFormat = (id: string): string => id */
@react.component
let make: (~id: string) => React.element
}
module H1: {
@react.component
let make: (~children: React.element) => React.element
}
module H2: {
@react.component
let make: (~id: string, ~children: React.element) => React.element
}
module H3: {
@react.component
let make: (~id: string, ~children: React.element) => React.element
}
module H4: {
@react.component
let make: (~id: string, ~children: React.element) => React.element
}
module H5: {
@react.component
let make: (~id: string, ~children: React.element) => React.element
}
module Pre: {
@react.component
let make: (~children: React.element) => React.element
}
module Table: {
@react.component
let make: (~children: React.element) => React.element
}
module Thead: {
@react.component
let make: (~children: React.element) => React.element
}
module Th: {
@react.component
let make: (~children: React.element) => React.element
}
module Td: {
@react.component
let make: (~children: React.element) => React.element
}
module Code: {
@react.component
let make: (
~className: string=?,
~metastring: option<string>,
~children: Mdx.Components.unknown,
) => React.element
}
module CodeTab: {
@react.component
let make: (~children: Mdx.MdxChildren.t, ~labels: array<string>=?) => React.element
}
module Blockquote: {
@react.component
let make: (~children: React.element) => React.element
}
module Hr: {
@react.component
let make: unit => React.element
}
/*
This will map either to an external link, or
an anchor / reference link.
TODO: Remark / Markdown actually has its own syntax
for references: e.g. [my article][1]
but it seems MDX doesn't map this to anything
specific (It seems as if it was represented as a text
node inside a <p> tag).
Example for the AST:
https://astexplorer.net/#/gist/2befce6edce1475eb4bbec001356b222/cede33d4c7545b8b2d759ded256802036ec3551c
Possible solution could be to write our own plugin to categorize those
specific component.
*/
module A: {
@react.component
let make: (~href: string, ~target: string=?, ~children: React.element) => React.element
}
module Ul: {
@react.component
let make: (~children: React.element) => React.element
}
module Ol: {
@react.component
let make: (~children: React.element) => React.element
}
module Li: {
@react.component
let make: (~children: React.element) => React.element
}
module Strong: {
@react.component
let make: (~children: React.element) => React.element
}
module Image: {
@react.component
let make: (
~src: string,
~size: [#large | #small]=?,
~withShadow: bool=?,
~caption: string=?,
~externalLink: string=?,
) => React.element
}
module Video: {
@react.component
let make: (~src: string, ~caption: string=?) => React.element
}
// Used for the MdxJS Provider
/* Sets our preferred branded styles
We most likely will never need a different ~components
option on our website. */