Skip to content

Commit 13218e9

Browse files
committed
Add definition for referenceType
1 parent ad733c5 commit 13218e9

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

readme.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -291,10 +291,20 @@ interface Footnote <: Parent {
291291
its `href` and `title` defined somewhere else in the document by a
292292
**Definition**.
293293

294+
`referenceType` is needed to detect if a reference was meant as a
295+
reference (`[foo][]`) or just unescaped brackets (`[foo]`).
296+
294297
```idl
295298
interface LinkReference <: Parent {
296299
type: "linkReference";
297300
identifier: string;
301+
referenceType: referenceType;
302+
}
303+
```
304+
305+
```idl
306+
enum referenceType {
307+
"shortcut" | "collapsed" | "full";
298308
}
299309
```
300310

@@ -304,11 +314,16 @@ interface LinkReference <: Parent {
304314
its `src` and `title` defined somewhere else in the document by a
305315
**Definition**.
306316

317+
`referenceType` is needed to detect if a reference was meant as a
318+
reference (`![foo][]`) or just unescaped brackets (`![foo]`).
319+
See **LinkReference** for the definition of `referenceType`.
320+
307321
```idl
308322
interface ImageReference <: Node {
309323
type: "imageReference";
310-
alt: string | null;
311324
identifier: string;
325+
referenceType: referenceType;
326+
alt: string | null;
312327
}
313328
```
314329

0 commit comments

Comments
 (0)