1 | /* tslint:disable */
|
2 | /**
|
3 | * This file was automatically generated by json-schema-to-typescript.
|
4 | * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
|
5 | * and run json-schema-to-typescript to regenerate this file.
|
6 | */
|
7 |
|
8 | /**
|
9 | * Myst syntax tree built on existing mdast schemas
|
10 | */
|
11 | export type Root = {
|
12 | type?: "root";
|
13 | /**
|
14 | * Top-level children of myst document
|
15 | */
|
16 | children?: (Block | BlockBreak | FlowContent)[] | ListContent[] | PhrasingContent[];
|
17 | position?: unknown;
|
18 | data?: unknown;
|
19 | } & Parent;
|
20 | /**
|
21 | * Top-level content blocks or cells the myst document, delimited by BlockBreaks
|
22 | */
|
23 | export type Block = {
|
24 | type?: "block";
|
25 | /**
|
26 | * block metadata from preceding break; conventionally, a stringified JSON dictionary but may be any arbitrary string
|
27 | */
|
28 | meta?: string;
|
29 | /**
|
30 | * Top-level children of myst document
|
31 | */
|
32 | children?: FlowContent[] | ListContent[] | PhrasingContent[];
|
33 | position?: unknown;
|
34 | data?: unknown;
|
35 | } & {
|
36 | /**
|
37 | * identifier for node variant
|
38 | */
|
39 | type: string;
|
40 | /**
|
41 | * information associated by the ecosystem with the node; never specified by mdast
|
42 | */
|
43 | data?: {
|
44 | [k: string]: unknown;
|
45 | };
|
46 | /**
|
47 | * location of node in source file; must not be present for generated nodes
|
48 | */
|
49 | position?: {
|
50 | /**
|
51 | * place of first character of parsed source region
|
52 | */
|
53 | start: {
|
54 | /**
|
55 | * line in the source file, 1-indexed
|
56 | */
|
57 | line: number;
|
58 | /**
|
59 | * column in the source file, 1-indexed
|
60 | */
|
61 | column: number;
|
62 | /**
|
63 | * offset character in the source file, 0-indexed
|
64 | */
|
65 | offset?: number;
|
66 | };
|
67 | /**
|
68 | * place of first character after parsed source region, whether it exists or not
|
69 | */
|
70 | end: {
|
71 | /**
|
72 | * line in the source file, 1-indexed
|
73 | */
|
74 | line: number;
|
75 | /**
|
76 | * column in the source file, 1-indexed
|
77 | */
|
78 | column: number;
|
79 | /**
|
80 | * offset character in the source file, 0-indexed
|
81 | */
|
82 | offset?: number;
|
83 | };
|
84 | /**
|
85 | * start column at each index in the source region, for elements that span multiple lines
|
86 | */
|
87 | indent?: number[];
|
88 | };
|
89 | };
|
90 | export type FlowContent =
|
91 | | Paragraph
|
92 | | Definition
|
93 | | Heading
|
94 | | ThematicBreak
|
95 | | Blockquote
|
96 | | List
|
97 | | HTML
|
98 | | Code
|
99 | | Comment
|
100 | | Target
|
101 | | Directive
|
102 | | Admonition
|
103 | | Container
|
104 | | Math
|
105 | | Table
|
106 | | FootnoteDefinition;
|
107 | export type Paragraph = {
|
108 | type?: "paragraph";
|
109 | children?: PhrasingContent[];
|
110 | position?: unknown;
|
111 | data?: unknown;
|
112 | } & ({
|
113 | /**
|
114 | * List of children nodes
|
115 | */
|
116 | children: Node[];
|
117 | } & {
|
118 | /**
|
119 | * identifier for node variant
|
120 | */
|
121 | type: string;
|
122 | /**
|
123 | * information associated by the ecosystem with the node; never specified by mdast
|
124 | */
|
125 | data?: {
|
126 | [k: string]: unknown;
|
127 | };
|
128 | /**
|
129 | * location of node in source file; must not be present for generated nodes
|
130 | */
|
131 | position?: {
|
132 | /**
|
133 | * place of first character of parsed source region
|
134 | */
|
135 | start: {
|
136 | /**
|
137 | * line in the source file, 1-indexed
|
138 | */
|
139 | line: number;
|
140 | /**
|
141 | * column in the source file, 1-indexed
|
142 | */
|
143 | column: number;
|
144 | /**
|
145 | * offset character in the source file, 0-indexed
|
146 | */
|
147 | offset?: number;
|
148 | };
|
149 | /**
|
150 | * place of first character after parsed source region, whether it exists or not
|
151 | */
|
152 | end: {
|
153 | /**
|
154 | * line in the source file, 1-indexed
|
155 | */
|
156 | line: number;
|
157 | /**
|
158 | * column in the source file, 1-indexed
|
159 | */
|
160 | column: number;
|
161 | /**
|
162 | * offset character in the source file, 0-indexed
|
163 | */
|
164 | offset?: number;
|
165 | };
|
166 | /**
|
167 | * start column at each index in the source region, for elements that span multiple lines
|
168 | */
|
169 | indent?: number[];
|
170 | };
|
171 | });
|
172 | export type PhrasingContent =
|
173 | | StaticPhrasingContent
|
174 | | Emphasis
|
175 | | Strong
|
176 | | Link
|
177 | | LinkReference
|
178 | | Subscript
|
179 | | Superscript
|
180 | | Underline
|
181 | | Abbreviation
|
182 | | CrossReference
|
183 | | FootnoteReference;
|
184 | export type StaticPhrasingContent =
|
185 | | Text
|
186 | | HTML
|
187 | | EmphasisStatic
|
188 | | StrongStatic
|
189 | | InlineCode
|
190 | | Break
|
191 | | Image
|
192 | | ImageReference
|
193 | | Role
|
194 | | SubscriptStatic
|
195 | | SuperscriptStatic
|
196 | | UnderlineStatic
|
197 | | InlineMath;
|
198 | export type Text = {
|
199 | type?: "text";
|
200 | value?: unknown;
|
201 | position?: unknown;
|
202 | data?: unknown;
|
203 | } & ({
|
204 | /**
|
205 | * The value of the node
|
206 | */
|
207 | value: string;
|
208 | } & {
|
209 | /**
|
210 | * identifier for node variant
|
211 | */
|
212 | type: string;
|
213 | /**
|
214 | * information associated by the ecosystem with the node; never specified by mdast
|
215 | */
|
216 | data?: {
|
217 | [k: string]: unknown;
|
218 | };
|
219 | /**
|
220 | * location of node in source file; must not be present for generated nodes
|
221 | */
|
222 | position?: {
|
223 | /**
|
224 | * place of first character of parsed source region
|
225 | */
|
226 | start: {
|
227 | /**
|
228 | * line in the source file, 1-indexed
|
229 | */
|
230 | line: number;
|
231 | /**
|
232 | * column in the source file, 1-indexed
|
233 | */
|
234 | column: number;
|
235 | /**
|
236 | * offset character in the source file, 0-indexed
|
237 | */
|
238 | offset?: number;
|
239 | };
|
240 | /**
|
241 | * place of first character after parsed source region, whether it exists or not
|
242 | */
|
243 | end: {
|
244 | /**
|
245 | * line in the source file, 1-indexed
|
246 | */
|
247 | line: number;
|
248 | /**
|
249 | * column in the source file, 1-indexed
|
250 | */
|
251 | column: number;
|
252 | /**
|
253 | * offset character in the source file, 0-indexed
|
254 | */
|
255 | offset?: number;
|
256 | };
|
257 | /**
|
258 | * start column at each index in the source region, for elements that span multiple lines
|
259 | */
|
260 | indent?: number[];
|
261 | };
|
262 | });
|
263 | /**
|
264 | * Fragment of raw HTML - does not need to be valid or complete
|
265 | */
|
266 | export type HTML = {
|
267 | type?: "html";
|
268 | value?: unknown;
|
269 | position?: unknown;
|
270 | data?: unknown;
|
271 | } & ({
|
272 | /**
|
273 | * The value of the node
|
274 | */
|
275 | value: string;
|
276 | } & {
|
277 | /**
|
278 | * identifier for node variant
|
279 | */
|
280 | type: string;
|
281 | /**
|
282 | * information associated by the ecosystem with the node; never specified by mdast
|
283 | */
|
284 | data?: {
|
285 | [k: string]: unknown;
|
286 | };
|
287 | /**
|
288 | * location of node in source file; must not be present for generated nodes
|
289 | */
|
290 | position?: {
|
291 | /**
|
292 | * place of first character of parsed source region
|
293 | */
|
294 | start: {
|
295 | /**
|
296 | * line in the source file, 1-indexed
|
297 | */
|
298 | line: number;
|
299 | /**
|
300 | * column in the source file, 1-indexed
|
301 | */
|
302 | column: number;
|
303 | /**
|
304 | * offset character in the source file, 0-indexed
|
305 | */
|
306 | offset?: number;
|
307 | };
|
308 | /**
|
309 | * place of first character after parsed source region, whether it exists or not
|
310 | */
|
311 | end: {
|
312 | /**
|
313 | * line in the source file, 1-indexed
|
314 | */
|
315 | line: number;
|
316 | /**
|
317 | * column in the source file, 1-indexed
|
318 | */
|
319 | column: number;
|
320 | /**
|
321 | * offset character in the source file, 0-indexed
|
322 | */
|
323 | offset?: number;
|
324 | };
|
325 | /**
|
326 | * start column at each index in the source region, for elements that span multiple lines
|
327 | */
|
328 | indent?: number[];
|
329 | };
|
330 | });
|
331 | /**
|
332 | * Stressed, italicized content, with static children; used when parent node requires static content
|
333 | */
|
334 | export type EmphasisStatic = {
|
335 | type?: "emphasis";
|
336 | children?: StaticPhrasingContent[];
|
337 | position?: unknown;
|
338 | data?: unknown;
|
339 | } & ({
|
340 | /**
|
341 | * List of children nodes
|
342 | */
|
343 | children: Node[];
|
344 | } & {
|
345 | /**
|
346 | * identifier for node variant
|
347 | */
|
348 | type: string;
|
349 | /**
|
350 | * information associated by the ecosystem with the node; never specified by mdast
|
351 | */
|
352 | data?: {
|
353 | [k: string]: unknown;
|
354 | };
|
355 | /**
|
356 | * location of node in source file; must not be present for generated nodes
|
357 | */
|
358 | position?: {
|
359 | /**
|
360 | * place of first character of parsed source region
|
361 | */
|
362 | start: {
|
363 | /**
|
364 | * line in the source file, 1-indexed
|
365 | */
|
366 | line: number;
|
367 | /**
|
368 | * column in the source file, 1-indexed
|
369 | */
|
370 | column: number;
|
371 | /**
|
372 | * offset character in the source file, 0-indexed
|
373 | */
|
374 | offset?: number;
|
375 | };
|
376 | /**
|
377 | * place of first character after parsed source region, whether it exists or not
|
378 | */
|
379 | end: {
|
380 | /**
|
381 | * line in the source file, 1-indexed
|
382 | */
|
383 | line: number;
|
384 | /**
|
385 | * column in the source file, 1-indexed
|
386 | */
|
387 | column: number;
|
388 | /**
|
389 | * offset character in the source file, 0-indexed
|
390 | */
|
391 | offset?: number;
|
392 | };
|
393 | /**
|
394 | * start column at each index in the source region, for elements that span multiple lines
|
395 | */
|
396 | indent?: number[];
|
397 | };
|
398 | });
|
399 | /**
|
400 | * Important, serious, urgent, bold content, with static children; used when parent node requires static content
|
401 | */
|
402 | export type StrongStatic = {
|
403 | type?: "strong";
|
404 | children?: StaticPhrasingContent[];
|
405 | position?: unknown;
|
406 | data?: unknown;
|
407 | } & ({
|
408 | /**
|
409 | * List of children nodes
|
410 | */
|
411 | children: Node[];
|
412 | } & {
|
413 | /**
|
414 | * identifier for node variant
|
415 | */
|
416 | type: string;
|
417 | /**
|
418 | * information associated by the ecosystem with the node; never specified by mdast
|
419 | */
|
420 | data?: {
|
421 | [k: string]: unknown;
|
422 | };
|
423 | /**
|
424 | * location of node in source file; must not be present for generated nodes
|
425 | */
|
426 | position?: {
|
427 | /**
|
428 | * place of first character of parsed source region
|
429 | */
|
430 | start: {
|
431 | /**
|
432 | * line in the source file, 1-indexed
|
433 | */
|
434 | line: number;
|
435 | /**
|
436 | * column in the source file, 1-indexed
|
437 | */
|
438 | column: number;
|
439 | /**
|
440 | * offset character in the source file, 0-indexed
|
441 | */
|
442 | offset?: number;
|
443 | };
|
444 | /**
|
445 | * place of first character after parsed source region, whether it exists or not
|
446 | */
|
447 | end: {
|
448 | /**
|
449 | * line in the source file, 1-indexed
|
450 | */
|
451 | line: number;
|
452 | /**
|
453 | * column in the source file, 1-indexed
|
454 | */
|
455 | column: number;
|
456 | /**
|
457 | * offset character in the source file, 0-indexed
|
458 | */
|
459 | offset?: number;
|
460 | };
|
461 | /**
|
462 | * start column at each index in the source region, for elements that span multiple lines
|
463 | */
|
464 | indent?: number[];
|
465 | };
|
466 | });
|
467 | /**
|
468 | * Fragment of code
|
469 | */
|
470 | export type InlineCode = {
|
471 | type?: "inlineCode";
|
472 | value?: unknown;
|
473 | position?: unknown;
|
474 | data?: unknown;
|
475 | } & ({
|
476 | /**
|
477 | * The value of the node
|
478 | */
|
479 | value: string;
|
480 | } & {
|
481 | /**
|
482 | * identifier for node variant
|
483 | */
|
484 | type: string;
|
485 | /**
|
486 | * information associated by the ecosystem with the node; never specified by mdast
|
487 | */
|
488 | data?: {
|
489 | [k: string]: unknown;
|
490 | };
|
491 | /**
|
492 | * location of node in source file; must not be present for generated nodes
|
493 | */
|
494 | position?: {
|
495 | /**
|
496 | * place of first character of parsed source region
|
497 | */
|
498 | start: {
|
499 | /**
|
500 | * line in the source file, 1-indexed
|
501 | */
|
502 | line: number;
|
503 | /**
|
504 | * column in the source file, 1-indexed
|
505 | */
|
506 | column: number;
|
507 | /**
|
508 | * offset character in the source file, 0-indexed
|
509 | */
|
510 | offset?: number;
|
511 | };
|
512 | /**
|
513 | * place of first character after parsed source region, whether it exists or not
|
514 | */
|
515 | end: {
|
516 | /**
|
517 | * line in the source file, 1-indexed
|
518 | */
|
519 | line: number;
|
520 | /**
|
521 | * column in the source file, 1-indexed
|
522 | */
|
523 | column: number;
|
524 | /**
|
525 | * offset character in the source file, 0-indexed
|
526 | */
|
527 | offset?: number;
|
528 | };
|
529 | /**
|
530 | * start column at each index in the source region, for elements that span multiple lines
|
531 | */
|
532 | indent?: number[];
|
533 | };
|
534 | });
|
535 | /**
|
536 | * Line break
|
537 | */
|
538 | export type Break = {
|
539 | type?: "break";
|
540 | position?: unknown;
|
541 | data?: unknown;
|
542 | } & {
|
543 | /**
|
544 | * identifier for node variant
|
545 | */
|
546 | type: string;
|
547 | /**
|
548 | * information associated by the ecosystem with the node; never specified by mdast
|
549 | */
|
550 | data?: {
|
551 | [k: string]: unknown;
|
552 | };
|
553 | /**
|
554 | * location of node in source file; must not be present for generated nodes
|
555 | */
|
556 | position?: {
|
557 | /**
|
558 | * place of first character of parsed source region
|
559 | */
|
560 | start: {
|
561 | /**
|
562 | * line in the source file, 1-indexed
|
563 | */
|
564 | line: number;
|
565 | /**
|
566 | * column in the source file, 1-indexed
|
567 | */
|
568 | column: number;
|
569 | /**
|
570 | * offset character in the source file, 0-indexed
|
571 | */
|
572 | offset?: number;
|
573 | };
|
574 | /**
|
575 | * place of first character after parsed source region, whether it exists or not
|
576 | */
|
577 | end: {
|
578 | /**
|
579 | * line in the source file, 1-indexed
|
580 | */
|
581 | line: number;
|
582 | /**
|
583 | * column in the source file, 1-indexed
|
584 | */
|
585 | column: number;
|
586 | /**
|
587 | * offset character in the source file, 0-indexed
|
588 | */
|
589 | offset?: number;
|
590 | };
|
591 | /**
|
592 | * start column at each index in the source region, for elements that span multiple lines
|
593 | */
|
594 | indent?: number[];
|
595 | };
|
596 | };
|
597 | /**
|
598 | * Image hyperlink
|
599 | */
|
600 | export type Image = {
|
601 | type?: "image";
|
602 | /**
|
603 | * user-defined class for image
|
604 | */
|
605 | class?: string;
|
606 | /**
|
607 | * image width in pixels or percentage
|
608 | */
|
609 | width?: string;
|
610 | align?: "left" | "center" | "right";
|
611 | url?: unknown;
|
612 | title?: unknown;
|
613 | alt?: unknown;
|
614 | position?: unknown;
|
615 | data?: unknown;
|
616 | } & {
|
617 | /**
|
618 | * A Uniform Resource Locator (URL) to an external resource or link.
|
619 | */
|
620 | url: string;
|
621 | /**
|
622 | * advisory information, e.g. for a tooltip
|
623 | */
|
624 | title?: string;
|
625 | } & {
|
626 | /**
|
627 | * field describing the image
|
628 | */
|
629 | alt?: string;
|
630 | } & {
|
631 | /**
|
632 | * identifier for node variant
|
633 | */
|
634 | type: string;
|
635 | /**
|
636 | * information associated by the ecosystem with the node; never specified by mdast
|
637 | */
|
638 | data?: {
|
639 | [k: string]: unknown;
|
640 | };
|
641 | /**
|
642 | * location of node in source file; must not be present for generated nodes
|
643 | */
|
644 | position?: {
|
645 | /**
|
646 | * place of first character of parsed source region
|
647 | */
|
648 | start: {
|
649 | /**
|
650 | * line in the source file, 1-indexed
|
651 | */
|
652 | line: number;
|
653 | /**
|
654 | * column in the source file, 1-indexed
|
655 | */
|
656 | column: number;
|
657 | /**
|
658 | * offset character in the source file, 0-indexed
|
659 | */
|
660 | offset?: number;
|
661 | };
|
662 | /**
|
663 | * place of first character after parsed source region, whether it exists or not
|
664 | */
|
665 | end: {
|
666 | /**
|
667 | * line in the source file, 1-indexed
|
668 | */
|
669 | line: number;
|
670 | /**
|
671 | * column in the source file, 1-indexed
|
672 | */
|
673 | column: number;
|
674 | /**
|
675 | * offset character in the source file, 0-indexed
|
676 | */
|
677 | offset?: number;
|
678 | };
|
679 | /**
|
680 | * start column at each index in the source region, for elements that span multiple lines
|
681 | */
|
682 | indent?: number[];
|
683 | };
|
684 | };
|
685 | /**
|
686 | * Image through association
|
687 | */
|
688 | export type ImageReference = {
|
689 | type?: "imageReference";
|
690 | referenceType?: unknown;
|
691 | identifier?: unknown;
|
692 | label?: unknown;
|
693 | alt?: unknown;
|
694 | position?: unknown;
|
695 | data?: unknown;
|
696 | } & {
|
697 | /**
|
698 | * explicitness of the reference:
|
699 | * `shortcut` - reference is implicit, identifier inferred
|
700 | * `collapsed` - reference explicit, identifier inferred
|
701 | * `full` - reference explicit, identifier explicit
|
702 | */
|
703 | referenceType: "shortcut" | "collapsed" | "full";
|
704 | } & ({
|
705 | identifier: unknown;
|
706 | } & {
|
707 | /**
|
708 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
709 | */
|
710 | identifier?: string;
|
711 | /**
|
712 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
713 | */
|
714 | label?: string;
|
715 | }) & {
|
716 | /**
|
717 | * field describing the image
|
718 | */
|
719 | alt?: string;
|
720 | } & {
|
721 | /**
|
722 | * identifier for node variant
|
723 | */
|
724 | type: string;
|
725 | /**
|
726 | * information associated by the ecosystem with the node; never specified by mdast
|
727 | */
|
728 | data?: {
|
729 | [k: string]: unknown;
|
730 | };
|
731 | /**
|
732 | * location of node in source file; must not be present for generated nodes
|
733 | */
|
734 | position?: {
|
735 | /**
|
736 | * place of first character of parsed source region
|
737 | */
|
738 | start: {
|
739 | /**
|
740 | * line in the source file, 1-indexed
|
741 | */
|
742 | line: number;
|
743 | /**
|
744 | * column in the source file, 1-indexed
|
745 | */
|
746 | column: number;
|
747 | /**
|
748 | * offset character in the source file, 0-indexed
|
749 | */
|
750 | offset?: number;
|
751 | };
|
752 | /**
|
753 | * place of first character after parsed source region, whether it exists or not
|
754 | */
|
755 | end: {
|
756 | /**
|
757 | * line in the source file, 1-indexed
|
758 | */
|
759 | line: number;
|
760 | /**
|
761 | * column in the source file, 1-indexed
|
762 | */
|
763 | column: number;
|
764 | /**
|
765 | * offset character in the source file, 0-indexed
|
766 | */
|
767 | offset?: number;
|
768 | };
|
769 | /**
|
770 | * start column at each index in the source region, for elements that span multiple lines
|
771 | */
|
772 | indent?: number[];
|
773 | };
|
774 | };
|
775 | /**
|
776 | * Custom in-line behavior
|
777 | */
|
778 | export type Role = {
|
779 | type?: "mystRole";
|
780 | name: string;
|
781 | /**
|
782 | * content of the directive
|
783 | */
|
784 | value?: string;
|
785 | /**
|
786 | * parsed role content
|
787 | */
|
788 | children?: PhrasingContent[];
|
789 | position?: unknown;
|
790 | data?: unknown;
|
791 | } & {
|
792 | /**
|
793 | * identifier for node variant
|
794 | */
|
795 | type: string;
|
796 | /**
|
797 | * information associated by the ecosystem with the node; never specified by mdast
|
798 | */
|
799 | data?: {
|
800 | [k: string]: unknown;
|
801 | };
|
802 | /**
|
803 | * location of node in source file; must not be present for generated nodes
|
804 | */
|
805 | position?: {
|
806 | /**
|
807 | * place of first character of parsed source region
|
808 | */
|
809 | start: {
|
810 | /**
|
811 | * line in the source file, 1-indexed
|
812 | */
|
813 | line: number;
|
814 | /**
|
815 | * column in the source file, 1-indexed
|
816 | */
|
817 | column: number;
|
818 | /**
|
819 | * offset character in the source file, 0-indexed
|
820 | */
|
821 | offset?: number;
|
822 | };
|
823 | /**
|
824 | * place of first character after parsed source region, whether it exists or not
|
825 | */
|
826 | end: {
|
827 | /**
|
828 | * line in the source file, 1-indexed
|
829 | */
|
830 | line: number;
|
831 | /**
|
832 | * column in the source file, 1-indexed
|
833 | */
|
834 | column: number;
|
835 | /**
|
836 | * offset character in the source file, 0-indexed
|
837 | */
|
838 | offset?: number;
|
839 | };
|
840 | /**
|
841 | * start column at each index in the source region, for elements that span multiple lines
|
842 | */
|
843 | indent?: number[];
|
844 | };
|
845 | };
|
846 | /**
|
847 | * Subscript content, with static children; used when parent node requires static content
|
848 | */
|
849 | export type SubscriptStatic = {
|
850 | type?: "subscript";
|
851 | children?: StaticPhrasingContent[];
|
852 | position?: unknown;
|
853 | data?: unknown;
|
854 | } & ({
|
855 | /**
|
856 | * List of children nodes
|
857 | */
|
858 | children: Node[];
|
859 | } & {
|
860 | /**
|
861 | * identifier for node variant
|
862 | */
|
863 | type: string;
|
864 | /**
|
865 | * information associated by the ecosystem with the node; never specified by mdast
|
866 | */
|
867 | data?: {
|
868 | [k: string]: unknown;
|
869 | };
|
870 | /**
|
871 | * location of node in source file; must not be present for generated nodes
|
872 | */
|
873 | position?: {
|
874 | /**
|
875 | * place of first character of parsed source region
|
876 | */
|
877 | start: {
|
878 | /**
|
879 | * line in the source file, 1-indexed
|
880 | */
|
881 | line: number;
|
882 | /**
|
883 | * column in the source file, 1-indexed
|
884 | */
|
885 | column: number;
|
886 | /**
|
887 | * offset character in the source file, 0-indexed
|
888 | */
|
889 | offset?: number;
|
890 | };
|
891 | /**
|
892 | * place of first character after parsed source region, whether it exists or not
|
893 | */
|
894 | end: {
|
895 | /**
|
896 | * line in the source file, 1-indexed
|
897 | */
|
898 | line: number;
|
899 | /**
|
900 | * column in the source file, 1-indexed
|
901 | */
|
902 | column: number;
|
903 | /**
|
904 | * offset character in the source file, 0-indexed
|
905 | */
|
906 | offset?: number;
|
907 | };
|
908 | /**
|
909 | * start column at each index in the source region, for elements that span multiple lines
|
910 | */
|
911 | indent?: number[];
|
912 | };
|
913 | });
|
914 | /**
|
915 | * Superscript content, with static children; used when parent node requires static content
|
916 | */
|
917 | export type SuperscriptStatic = {
|
918 | type?: "superscript";
|
919 | children?: StaticPhrasingContent[];
|
920 | position?: unknown;
|
921 | data?: unknown;
|
922 | } & ({
|
923 | /**
|
924 | * List of children nodes
|
925 | */
|
926 | children: Node[];
|
927 | } & {
|
928 | /**
|
929 | * identifier for node variant
|
930 | */
|
931 | type: string;
|
932 | /**
|
933 | * information associated by the ecosystem with the node; never specified by mdast
|
934 | */
|
935 | data?: {
|
936 | [k: string]: unknown;
|
937 | };
|
938 | /**
|
939 | * location of node in source file; must not be present for generated nodes
|
940 | */
|
941 | position?: {
|
942 | /**
|
943 | * place of first character of parsed source region
|
944 | */
|
945 | start: {
|
946 | /**
|
947 | * line in the source file, 1-indexed
|
948 | */
|
949 | line: number;
|
950 | /**
|
951 | * column in the source file, 1-indexed
|
952 | */
|
953 | column: number;
|
954 | /**
|
955 | * offset character in the source file, 0-indexed
|
956 | */
|
957 | offset?: number;
|
958 | };
|
959 | /**
|
960 | * place of first character after parsed source region, whether it exists or not
|
961 | */
|
962 | end: {
|
963 | /**
|
964 | * line in the source file, 1-indexed
|
965 | */
|
966 | line: number;
|
967 | /**
|
968 | * column in the source file, 1-indexed
|
969 | */
|
970 | column: number;
|
971 | /**
|
972 | * offset character in the source file, 0-indexed
|
973 | */
|
974 | offset?: number;
|
975 | };
|
976 | /**
|
977 | * start column at each index in the source region, for elements that span multiple lines
|
978 | */
|
979 | indent?: number[];
|
980 | };
|
981 | });
|
982 | /**
|
983 | * Underline content, with static children; used when parent node requires static content
|
984 | */
|
985 | export type UnderlineStatic = {
|
986 | type?: "underline";
|
987 | children?: StaticPhrasingContent[];
|
988 | position?: unknown;
|
989 | data?: unknown;
|
990 | } & ({
|
991 | /**
|
992 | * List of children nodes
|
993 | */
|
994 | children: Node[];
|
995 | } & {
|
996 | /**
|
997 | * identifier for node variant
|
998 | */
|
999 | type: string;
|
1000 | /**
|
1001 | * information associated by the ecosystem with the node; never specified by mdast
|
1002 | */
|
1003 | data?: {
|
1004 | [k: string]: unknown;
|
1005 | };
|
1006 | /**
|
1007 | * location of node in source file; must not be present for generated nodes
|
1008 | */
|
1009 | position?: {
|
1010 | /**
|
1011 | * place of first character of parsed source region
|
1012 | */
|
1013 | start: {
|
1014 | /**
|
1015 | * line in the source file, 1-indexed
|
1016 | */
|
1017 | line: number;
|
1018 | /**
|
1019 | * column in the source file, 1-indexed
|
1020 | */
|
1021 | column: number;
|
1022 | /**
|
1023 | * offset character in the source file, 0-indexed
|
1024 | */
|
1025 | offset?: number;
|
1026 | };
|
1027 | /**
|
1028 | * place of first character after parsed source region, whether it exists or not
|
1029 | */
|
1030 | end: {
|
1031 | /**
|
1032 | * line in the source file, 1-indexed
|
1033 | */
|
1034 | line: number;
|
1035 | /**
|
1036 | * column in the source file, 1-indexed
|
1037 | */
|
1038 | column: number;
|
1039 | /**
|
1040 | * offset character in the source file, 0-indexed
|
1041 | */
|
1042 | offset?: number;
|
1043 | };
|
1044 | /**
|
1045 | * start column at each index in the source region, for elements that span multiple lines
|
1046 | */
|
1047 | indent?: number[];
|
1048 | };
|
1049 | });
|
1050 | /**
|
1051 | * Fragment of math, similar to InlineCode, using role {math}
|
1052 | */
|
1053 | export type InlineMath = {
|
1054 | type?: "inlineMath";
|
1055 | value?: unknown;
|
1056 | position?: unknown;
|
1057 | data?: unknown;
|
1058 | } & ({
|
1059 | /**
|
1060 | * The value of the node
|
1061 | */
|
1062 | value: string;
|
1063 | } & {
|
1064 | /**
|
1065 | * identifier for node variant
|
1066 | */
|
1067 | type: string;
|
1068 | /**
|
1069 | * information associated by the ecosystem with the node; never specified by mdast
|
1070 | */
|
1071 | data?: {
|
1072 | [k: string]: unknown;
|
1073 | };
|
1074 | /**
|
1075 | * location of node in source file; must not be present for generated nodes
|
1076 | */
|
1077 | position?: {
|
1078 | /**
|
1079 | * place of first character of parsed source region
|
1080 | */
|
1081 | start: {
|
1082 | /**
|
1083 | * line in the source file, 1-indexed
|
1084 | */
|
1085 | line: number;
|
1086 | /**
|
1087 | * column in the source file, 1-indexed
|
1088 | */
|
1089 | column: number;
|
1090 | /**
|
1091 | * offset character in the source file, 0-indexed
|
1092 | */
|
1093 | offset?: number;
|
1094 | };
|
1095 | /**
|
1096 | * place of first character after parsed source region, whether it exists or not
|
1097 | */
|
1098 | end: {
|
1099 | /**
|
1100 | * line in the source file, 1-indexed
|
1101 | */
|
1102 | line: number;
|
1103 | /**
|
1104 | * column in the source file, 1-indexed
|
1105 | */
|
1106 | column: number;
|
1107 | /**
|
1108 | * offset character in the source file, 0-indexed
|
1109 | */
|
1110 | offset?: number;
|
1111 | };
|
1112 | /**
|
1113 | * start column at each index in the source region, for elements that span multiple lines
|
1114 | */
|
1115 | indent?: number[];
|
1116 | };
|
1117 | });
|
1118 | /**
|
1119 | * Stressed, italicized content
|
1120 | */
|
1121 | export type Emphasis = {
|
1122 | type?: "emphasis";
|
1123 | children?: PhrasingContent[];
|
1124 | position?: unknown;
|
1125 | data?: unknown;
|
1126 | } & ({
|
1127 | /**
|
1128 | * List of children nodes
|
1129 | */
|
1130 | children: Node[];
|
1131 | } & {
|
1132 | /**
|
1133 | * identifier for node variant
|
1134 | */
|
1135 | type: string;
|
1136 | /**
|
1137 | * information associated by the ecosystem with the node; never specified by mdast
|
1138 | */
|
1139 | data?: {
|
1140 | [k: string]: unknown;
|
1141 | };
|
1142 | /**
|
1143 | * location of node in source file; must not be present for generated nodes
|
1144 | */
|
1145 | position?: {
|
1146 | /**
|
1147 | * place of first character of parsed source region
|
1148 | */
|
1149 | start: {
|
1150 | /**
|
1151 | * line in the source file, 1-indexed
|
1152 | */
|
1153 | line: number;
|
1154 | /**
|
1155 | * column in the source file, 1-indexed
|
1156 | */
|
1157 | column: number;
|
1158 | /**
|
1159 | * offset character in the source file, 0-indexed
|
1160 | */
|
1161 | offset?: number;
|
1162 | };
|
1163 | /**
|
1164 | * place of first character after parsed source region, whether it exists or not
|
1165 | */
|
1166 | end: {
|
1167 | /**
|
1168 | * line in the source file, 1-indexed
|
1169 | */
|
1170 | line: number;
|
1171 | /**
|
1172 | * column in the source file, 1-indexed
|
1173 | */
|
1174 | column: number;
|
1175 | /**
|
1176 | * offset character in the source file, 0-indexed
|
1177 | */
|
1178 | offset?: number;
|
1179 | };
|
1180 | /**
|
1181 | * start column at each index in the source region, for elements that span multiple lines
|
1182 | */
|
1183 | indent?: number[];
|
1184 | };
|
1185 | });
|
1186 | /**
|
1187 | * Important, serious, urgent, bold content
|
1188 | */
|
1189 | export type Strong = {
|
1190 | type?: "strong";
|
1191 | children?: PhrasingContent[];
|
1192 | position?: unknown;
|
1193 | data?: unknown;
|
1194 | } & ({
|
1195 | /**
|
1196 | * List of children nodes
|
1197 | */
|
1198 | children: Node[];
|
1199 | } & {
|
1200 | /**
|
1201 | * identifier for node variant
|
1202 | */
|
1203 | type: string;
|
1204 | /**
|
1205 | * information associated by the ecosystem with the node; never specified by mdast
|
1206 | */
|
1207 | data?: {
|
1208 | [k: string]: unknown;
|
1209 | };
|
1210 | /**
|
1211 | * location of node in source file; must not be present for generated nodes
|
1212 | */
|
1213 | position?: {
|
1214 | /**
|
1215 | * place of first character of parsed source region
|
1216 | */
|
1217 | start: {
|
1218 | /**
|
1219 | * line in the source file, 1-indexed
|
1220 | */
|
1221 | line: number;
|
1222 | /**
|
1223 | * column in the source file, 1-indexed
|
1224 | */
|
1225 | column: number;
|
1226 | /**
|
1227 | * offset character in the source file, 0-indexed
|
1228 | */
|
1229 | offset?: number;
|
1230 | };
|
1231 | /**
|
1232 | * place of first character after parsed source region, whether it exists or not
|
1233 | */
|
1234 | end: {
|
1235 | /**
|
1236 | * line in the source file, 1-indexed
|
1237 | */
|
1238 | line: number;
|
1239 | /**
|
1240 | * column in the source file, 1-indexed
|
1241 | */
|
1242 | column: number;
|
1243 | /**
|
1244 | * offset character in the source file, 0-indexed
|
1245 | */
|
1246 | offset?: number;
|
1247 | };
|
1248 | /**
|
1249 | * start column at each index in the source region, for elements that span multiple lines
|
1250 | */
|
1251 | indent?: number[];
|
1252 | };
|
1253 | });
|
1254 | /**
|
1255 | * Hyperlink
|
1256 | */
|
1257 | export type Link = {
|
1258 | type?: "link";
|
1259 | children?: StaticPhrasingContent[];
|
1260 | url?: unknown;
|
1261 | title?: unknown;
|
1262 | position?: unknown;
|
1263 | data?: unknown;
|
1264 | } & {
|
1265 | /**
|
1266 | * A Uniform Resource Locator (URL) to an external resource or link.
|
1267 | */
|
1268 | url: string;
|
1269 | /**
|
1270 | * advisory information, e.g. for a tooltip
|
1271 | */
|
1272 | title?: string;
|
1273 | } & ({
|
1274 | /**
|
1275 | * List of children nodes
|
1276 | */
|
1277 | children: Node[];
|
1278 | } & {
|
1279 | /**
|
1280 | * identifier for node variant
|
1281 | */
|
1282 | type: string;
|
1283 | /**
|
1284 | * information associated by the ecosystem with the node; never specified by mdast
|
1285 | */
|
1286 | data?: {
|
1287 | [k: string]: unknown;
|
1288 | };
|
1289 | /**
|
1290 | * location of node in source file; must not be present for generated nodes
|
1291 | */
|
1292 | position?: {
|
1293 | /**
|
1294 | * place of first character of parsed source region
|
1295 | */
|
1296 | start: {
|
1297 | /**
|
1298 | * line in the source file, 1-indexed
|
1299 | */
|
1300 | line: number;
|
1301 | /**
|
1302 | * column in the source file, 1-indexed
|
1303 | */
|
1304 | column: number;
|
1305 | /**
|
1306 | * offset character in the source file, 0-indexed
|
1307 | */
|
1308 | offset?: number;
|
1309 | };
|
1310 | /**
|
1311 | * place of first character after parsed source region, whether it exists or not
|
1312 | */
|
1313 | end: {
|
1314 | /**
|
1315 | * line in the source file, 1-indexed
|
1316 | */
|
1317 | line: number;
|
1318 | /**
|
1319 | * column in the source file, 1-indexed
|
1320 | */
|
1321 | column: number;
|
1322 | /**
|
1323 | * offset character in the source file, 0-indexed
|
1324 | */
|
1325 | offset?: number;
|
1326 | };
|
1327 | /**
|
1328 | * start column at each index in the source region, for elements that span multiple lines
|
1329 | */
|
1330 | indent?: number[];
|
1331 | };
|
1332 | });
|
1333 | /**
|
1334 | * Hyperlink through association
|
1335 | */
|
1336 | export type LinkReference = {
|
1337 | type?: "linkReference";
|
1338 | children?: StaticPhrasingContent[];
|
1339 | referenceType?: unknown;
|
1340 | identifier?: unknown;
|
1341 | label?: unknown;
|
1342 | position?: unknown;
|
1343 | data?: unknown;
|
1344 | } & {
|
1345 | /**
|
1346 | * explicitness of the reference:
|
1347 | * `shortcut` - reference is implicit, identifier inferred
|
1348 | * `collapsed` - reference explicit, identifier inferred
|
1349 | * `full` - reference explicit, identifier explicit
|
1350 | */
|
1351 | referenceType: "shortcut" | "collapsed" | "full";
|
1352 | } & ({
|
1353 | identifier: unknown;
|
1354 | } & {
|
1355 | /**
|
1356 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
1357 | */
|
1358 | identifier?: string;
|
1359 | /**
|
1360 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
1361 | */
|
1362 | label?: string;
|
1363 | }) &
|
1364 | ({
|
1365 | /**
|
1366 | * List of children nodes
|
1367 | */
|
1368 | children: Node[];
|
1369 | } & {
|
1370 | /**
|
1371 | * identifier for node variant
|
1372 | */
|
1373 | type: string;
|
1374 | /**
|
1375 | * information associated by the ecosystem with the node; never specified by mdast
|
1376 | */
|
1377 | data?: {
|
1378 | [k: string]: unknown;
|
1379 | };
|
1380 | /**
|
1381 | * location of node in source file; must not be present for generated nodes
|
1382 | */
|
1383 | position?: {
|
1384 | /**
|
1385 | * place of first character of parsed source region
|
1386 | */
|
1387 | start: {
|
1388 | /**
|
1389 | * line in the source file, 1-indexed
|
1390 | */
|
1391 | line: number;
|
1392 | /**
|
1393 | * column in the source file, 1-indexed
|
1394 | */
|
1395 | column: number;
|
1396 | /**
|
1397 | * offset character in the source file, 0-indexed
|
1398 | */
|
1399 | offset?: number;
|
1400 | };
|
1401 | /**
|
1402 | * place of first character after parsed source region, whether it exists or not
|
1403 | */
|
1404 | end: {
|
1405 | /**
|
1406 | * line in the source file, 1-indexed
|
1407 | */
|
1408 | line: number;
|
1409 | /**
|
1410 | * column in the source file, 1-indexed
|
1411 | */
|
1412 | column: number;
|
1413 | /**
|
1414 | * offset character in the source file, 0-indexed
|
1415 | */
|
1416 | offset?: number;
|
1417 | };
|
1418 | /**
|
1419 | * start column at each index in the source region, for elements that span multiple lines
|
1420 | */
|
1421 | indent?: number[];
|
1422 | };
|
1423 | });
|
1424 | /**
|
1425 | * Subscript content, using role {subscript}
|
1426 | */
|
1427 | export type Subscript = {
|
1428 | type?: "subscript";
|
1429 | children?: PhrasingContent[];
|
1430 | position?: unknown;
|
1431 | data?: unknown;
|
1432 | } & ({
|
1433 | /**
|
1434 | * List of children nodes
|
1435 | */
|
1436 | children: Node[];
|
1437 | } & {
|
1438 | /**
|
1439 | * identifier for node variant
|
1440 | */
|
1441 | type: string;
|
1442 | /**
|
1443 | * information associated by the ecosystem with the node; never specified by mdast
|
1444 | */
|
1445 | data?: {
|
1446 | [k: string]: unknown;
|
1447 | };
|
1448 | /**
|
1449 | * location of node in source file; must not be present for generated nodes
|
1450 | */
|
1451 | position?: {
|
1452 | /**
|
1453 | * place of first character of parsed source region
|
1454 | */
|
1455 | start: {
|
1456 | /**
|
1457 | * line in the source file, 1-indexed
|
1458 | */
|
1459 | line: number;
|
1460 | /**
|
1461 | * column in the source file, 1-indexed
|
1462 | */
|
1463 | column: number;
|
1464 | /**
|
1465 | * offset character in the source file, 0-indexed
|
1466 | */
|
1467 | offset?: number;
|
1468 | };
|
1469 | /**
|
1470 | * place of first character after parsed source region, whether it exists or not
|
1471 | */
|
1472 | end: {
|
1473 | /**
|
1474 | * line in the source file, 1-indexed
|
1475 | */
|
1476 | line: number;
|
1477 | /**
|
1478 | * column in the source file, 1-indexed
|
1479 | */
|
1480 | column: number;
|
1481 | /**
|
1482 | * offset character in the source file, 0-indexed
|
1483 | */
|
1484 | offset?: number;
|
1485 | };
|
1486 | /**
|
1487 | * start column at each index in the source region, for elements that span multiple lines
|
1488 | */
|
1489 | indent?: number[];
|
1490 | };
|
1491 | });
|
1492 | /**
|
1493 | * Superscript content, using role {superscript}
|
1494 | */
|
1495 | export type Superscript = {
|
1496 | type?: "superscript";
|
1497 | children?: PhrasingContent[];
|
1498 | position?: unknown;
|
1499 | data?: unknown;
|
1500 | } & ({
|
1501 | /**
|
1502 | * List of children nodes
|
1503 | */
|
1504 | children: Node[];
|
1505 | } & {
|
1506 | /**
|
1507 | * identifier for node variant
|
1508 | */
|
1509 | type: string;
|
1510 | /**
|
1511 | * information associated by the ecosystem with the node; never specified by mdast
|
1512 | */
|
1513 | data?: {
|
1514 | [k: string]: unknown;
|
1515 | };
|
1516 | /**
|
1517 | * location of node in source file; must not be present for generated nodes
|
1518 | */
|
1519 | position?: {
|
1520 | /**
|
1521 | * place of first character of parsed source region
|
1522 | */
|
1523 | start: {
|
1524 | /**
|
1525 | * line in the source file, 1-indexed
|
1526 | */
|
1527 | line: number;
|
1528 | /**
|
1529 | * column in the source file, 1-indexed
|
1530 | */
|
1531 | column: number;
|
1532 | /**
|
1533 | * offset character in the source file, 0-indexed
|
1534 | */
|
1535 | offset?: number;
|
1536 | };
|
1537 | /**
|
1538 | * place of first character after parsed source region, whether it exists or not
|
1539 | */
|
1540 | end: {
|
1541 | /**
|
1542 | * line in the source file, 1-indexed
|
1543 | */
|
1544 | line: number;
|
1545 | /**
|
1546 | * column in the source file, 1-indexed
|
1547 | */
|
1548 | column: number;
|
1549 | /**
|
1550 | * offset character in the source file, 0-indexed
|
1551 | */
|
1552 | offset?: number;
|
1553 | };
|
1554 | /**
|
1555 | * start column at each index in the source region, for elements that span multiple lines
|
1556 | */
|
1557 | indent?: number[];
|
1558 | };
|
1559 | });
|
1560 | /**
|
1561 | * Underline content, using role {underline}
|
1562 | */
|
1563 | export type Underline = {
|
1564 | type?: "underline";
|
1565 | children?: PhrasingContent[];
|
1566 | position?: unknown;
|
1567 | data?: unknown;
|
1568 | } & ({
|
1569 | /**
|
1570 | * List of children nodes
|
1571 | */
|
1572 | children: Node[];
|
1573 | } & {
|
1574 | /**
|
1575 | * identifier for node variant
|
1576 | */
|
1577 | type: string;
|
1578 | /**
|
1579 | * information associated by the ecosystem with the node; never specified by mdast
|
1580 | */
|
1581 | data?: {
|
1582 | [k: string]: unknown;
|
1583 | };
|
1584 | /**
|
1585 | * location of node in source file; must not be present for generated nodes
|
1586 | */
|
1587 | position?: {
|
1588 | /**
|
1589 | * place of first character of parsed source region
|
1590 | */
|
1591 | start: {
|
1592 | /**
|
1593 | * line in the source file, 1-indexed
|
1594 | */
|
1595 | line: number;
|
1596 | /**
|
1597 | * column in the source file, 1-indexed
|
1598 | */
|
1599 | column: number;
|
1600 | /**
|
1601 | * offset character in the source file, 0-indexed
|
1602 | */
|
1603 | offset?: number;
|
1604 | };
|
1605 | /**
|
1606 | * place of first character after parsed source region, whether it exists or not
|
1607 | */
|
1608 | end: {
|
1609 | /**
|
1610 | * line in the source file, 1-indexed
|
1611 | */
|
1612 | line: number;
|
1613 | /**
|
1614 | * column in the source file, 1-indexed
|
1615 | */
|
1616 | column: number;
|
1617 | /**
|
1618 | * offset character in the source file, 0-indexed
|
1619 | */
|
1620 | offset?: number;
|
1621 | };
|
1622 | /**
|
1623 | * start column at each index in the source region, for elements that span multiple lines
|
1624 | */
|
1625 | indent?: number[];
|
1626 | };
|
1627 | });
|
1628 | /**
|
1629 | * Abbreviation node described by title
|
1630 | */
|
1631 | export type Abbreviation = {
|
1632 | type?: "abbreviation";
|
1633 | /**
|
1634 | * abbreviated value
|
1635 | */
|
1636 | children?: StaticPhrasingContent[];
|
1637 | /**
|
1638 | * advisory information for the abbreviation
|
1639 | */
|
1640 | title?: string;
|
1641 | position?: unknown;
|
1642 | data?: unknown;
|
1643 | } & ({
|
1644 | /**
|
1645 | * List of children nodes
|
1646 | */
|
1647 | children: Node[];
|
1648 | } & {
|
1649 | /**
|
1650 | * identifier for node variant
|
1651 | */
|
1652 | type: string;
|
1653 | /**
|
1654 | * information associated by the ecosystem with the node; never specified by mdast
|
1655 | */
|
1656 | data?: {
|
1657 | [k: string]: unknown;
|
1658 | };
|
1659 | /**
|
1660 | * location of node in source file; must not be present for generated nodes
|
1661 | */
|
1662 | position?: {
|
1663 | /**
|
1664 | * place of first character of parsed source region
|
1665 | */
|
1666 | start: {
|
1667 | /**
|
1668 | * line in the source file, 1-indexed
|
1669 | */
|
1670 | line: number;
|
1671 | /**
|
1672 | * column in the source file, 1-indexed
|
1673 | */
|
1674 | column: number;
|
1675 | /**
|
1676 | * offset character in the source file, 0-indexed
|
1677 | */
|
1678 | offset?: number;
|
1679 | };
|
1680 | /**
|
1681 | * place of first character after parsed source region, whether it exists or not
|
1682 | */
|
1683 | end: {
|
1684 | /**
|
1685 | * line in the source file, 1-indexed
|
1686 | */
|
1687 | line: number;
|
1688 | /**
|
1689 | * column in the source file, 1-indexed
|
1690 | */
|
1691 | column: number;
|
1692 | /**
|
1693 | * offset character in the source file, 0-indexed
|
1694 | */
|
1695 | offset?: number;
|
1696 | };
|
1697 | /**
|
1698 | * start column at each index in the source region, for elements that span multiple lines
|
1699 | */
|
1700 | indent?: number[];
|
1701 | };
|
1702 | });
|
1703 | /**
|
1704 | * In-line reference to an associated node
|
1705 | */
|
1706 | export type CrossReference = {
|
1707 | type?: "crossReference";
|
1708 | /**
|
1709 | * Indicates if the references should be numbered.
|
1710 | * ```{warning}
|
1711 | * The `kind` was based on docutils and is subject to change as we improve the `crossReference` experience.
|
1712 | * ```
|
1713 | */
|
1714 | kind?: "eq" | "numref" | "ref";
|
1715 | /**
|
1716 | * Children of the crossReference, can include text with "%s" or "{number}" and enumerated references will be filled in.
|
1717 | */
|
1718 | children?: StaticPhrasingContent[];
|
1719 | identifier?: unknown;
|
1720 | label?: unknown;
|
1721 | position?: unknown;
|
1722 | data?: unknown;
|
1723 | } & ({
|
1724 | identifier: unknown;
|
1725 | } & {
|
1726 | /**
|
1727 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
1728 | */
|
1729 | identifier?: string;
|
1730 | /**
|
1731 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
1732 | */
|
1733 | label?: string;
|
1734 | }) & {
|
1735 | /**
|
1736 | * identifier for node variant
|
1737 | */
|
1738 | type: string;
|
1739 | /**
|
1740 | * information associated by the ecosystem with the node; never specified by mdast
|
1741 | */
|
1742 | data?: {
|
1743 | [k: string]: unknown;
|
1744 | };
|
1745 | /**
|
1746 | * location of node in source file; must not be present for generated nodes
|
1747 | */
|
1748 | position?: {
|
1749 | /**
|
1750 | * place of first character of parsed source region
|
1751 | */
|
1752 | start: {
|
1753 | /**
|
1754 | * line in the source file, 1-indexed
|
1755 | */
|
1756 | line: number;
|
1757 | /**
|
1758 | * column in the source file, 1-indexed
|
1759 | */
|
1760 | column: number;
|
1761 | /**
|
1762 | * offset character in the source file, 0-indexed
|
1763 | */
|
1764 | offset?: number;
|
1765 | };
|
1766 | /**
|
1767 | * place of first character after parsed source region, whether it exists or not
|
1768 | */
|
1769 | end: {
|
1770 | /**
|
1771 | * line in the source file, 1-indexed
|
1772 | */
|
1773 | line: number;
|
1774 | /**
|
1775 | * column in the source file, 1-indexed
|
1776 | */
|
1777 | column: number;
|
1778 | /**
|
1779 | * offset character in the source file, 0-indexed
|
1780 | */
|
1781 | offset?: number;
|
1782 | };
|
1783 | /**
|
1784 | * start column at each index in the source region, for elements that span multiple lines
|
1785 | */
|
1786 | indent?: number[];
|
1787 | };
|
1788 | };
|
1789 | /**
|
1790 | * Inline reference to footnote
|
1791 | */
|
1792 | export type FootnoteReference = {
|
1793 | type?: "footnoteReference";
|
1794 | identifier?: unknown;
|
1795 | label?: unknown;
|
1796 | position?: unknown;
|
1797 | data?: unknown;
|
1798 | } & ({
|
1799 | identifier: unknown;
|
1800 | } & {
|
1801 | /**
|
1802 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
1803 | */
|
1804 | identifier?: string;
|
1805 | /**
|
1806 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
1807 | */
|
1808 | label?: string;
|
1809 | }) & {
|
1810 | /**
|
1811 | * identifier for node variant
|
1812 | */
|
1813 | type: string;
|
1814 | /**
|
1815 | * information associated by the ecosystem with the node; never specified by mdast
|
1816 | */
|
1817 | data?: {
|
1818 | [k: string]: unknown;
|
1819 | };
|
1820 | /**
|
1821 | * location of node in source file; must not be present for generated nodes
|
1822 | */
|
1823 | position?: {
|
1824 | /**
|
1825 | * place of first character of parsed source region
|
1826 | */
|
1827 | start: {
|
1828 | /**
|
1829 | * line in the source file, 1-indexed
|
1830 | */
|
1831 | line: number;
|
1832 | /**
|
1833 | * column in the source file, 1-indexed
|
1834 | */
|
1835 | column: number;
|
1836 | /**
|
1837 | * offset character in the source file, 0-indexed
|
1838 | */
|
1839 | offset?: number;
|
1840 | };
|
1841 | /**
|
1842 | * place of first character after parsed source region, whether it exists or not
|
1843 | */
|
1844 | end: {
|
1845 | /**
|
1846 | * line in the source file, 1-indexed
|
1847 | */
|
1848 | line: number;
|
1849 | /**
|
1850 | * column in the source file, 1-indexed
|
1851 | */
|
1852 | column: number;
|
1853 | /**
|
1854 | * offset character in the source file, 0-indexed
|
1855 | */
|
1856 | offset?: number;
|
1857 | };
|
1858 | /**
|
1859 | * start column at each index in the source region, for elements that span multiple lines
|
1860 | */
|
1861 | indent?: number[];
|
1862 | };
|
1863 | };
|
1864 | /**
|
1865 | * Reference to a url resource
|
1866 | */
|
1867 | export type Definition = {
|
1868 | type?: "definition";
|
1869 | identifier?: unknown;
|
1870 | label?: unknown;
|
1871 | url?: unknown;
|
1872 | title?: unknown;
|
1873 | position?: unknown;
|
1874 | data?: unknown;
|
1875 | } & ({
|
1876 | identifier: unknown;
|
1877 | } & {
|
1878 | /**
|
1879 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
1880 | */
|
1881 | identifier?: string;
|
1882 | /**
|
1883 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
1884 | */
|
1885 | label?: string;
|
1886 | }) & {
|
1887 | /**
|
1888 | * A Uniform Resource Locator (URL) to an external resource or link.
|
1889 | */
|
1890 | url: string;
|
1891 | /**
|
1892 | * advisory information, e.g. for a tooltip
|
1893 | */
|
1894 | title?: string;
|
1895 | } & {
|
1896 | /**
|
1897 | * identifier for node variant
|
1898 | */
|
1899 | type: string;
|
1900 | /**
|
1901 | * information associated by the ecosystem with the node; never specified by mdast
|
1902 | */
|
1903 | data?: {
|
1904 | [k: string]: unknown;
|
1905 | };
|
1906 | /**
|
1907 | * location of node in source file; must not be present for generated nodes
|
1908 | */
|
1909 | position?: {
|
1910 | /**
|
1911 | * place of first character of parsed source region
|
1912 | */
|
1913 | start: {
|
1914 | /**
|
1915 | * line in the source file, 1-indexed
|
1916 | */
|
1917 | line: number;
|
1918 | /**
|
1919 | * column in the source file, 1-indexed
|
1920 | */
|
1921 | column: number;
|
1922 | /**
|
1923 | * offset character in the source file, 0-indexed
|
1924 | */
|
1925 | offset?: number;
|
1926 | };
|
1927 | /**
|
1928 | * place of first character after parsed source region, whether it exists or not
|
1929 | */
|
1930 | end: {
|
1931 | /**
|
1932 | * line in the source file, 1-indexed
|
1933 | */
|
1934 | line: number;
|
1935 | /**
|
1936 | * column in the source file, 1-indexed
|
1937 | */
|
1938 | column: number;
|
1939 | /**
|
1940 | * offset character in the source file, 0-indexed
|
1941 | */
|
1942 | offset?: number;
|
1943 | };
|
1944 | /**
|
1945 | * start column at each index in the source region, for elements that span multiple lines
|
1946 | */
|
1947 | indent?: number[];
|
1948 | };
|
1949 | };
|
1950 | export type Heading = {
|
1951 | type?: "heading";
|
1952 | depth: number;
|
1953 | /**
|
1954 | * count this heading for numbering based on kind, e.g. Section 2.4.1
|
1955 | */
|
1956 | enumerated?: boolean;
|
1957 | /**
|
1958 | * resolved enumerated value for this heading
|
1959 | */
|
1960 | enumerator?: string;
|
1961 | children?: PhrasingContent[];
|
1962 | identifier?: unknown;
|
1963 | label?: unknown;
|
1964 | position?: unknown;
|
1965 | data?: unknown;
|
1966 | } & ({
|
1967 | /**
|
1968 | * List of children nodes
|
1969 | */
|
1970 | children: Node[];
|
1971 | } & {
|
1972 | /**
|
1973 | * identifier for node variant
|
1974 | */
|
1975 | type: string;
|
1976 | /**
|
1977 | * information associated by the ecosystem with the node; never specified by mdast
|
1978 | */
|
1979 | data?: {
|
1980 | [k: string]: unknown;
|
1981 | };
|
1982 | /**
|
1983 | * location of node in source file; must not be present for generated nodes
|
1984 | */
|
1985 | position?: {
|
1986 | /**
|
1987 | * place of first character of parsed source region
|
1988 | */
|
1989 | start: {
|
1990 | /**
|
1991 | * line in the source file, 1-indexed
|
1992 | */
|
1993 | line: number;
|
1994 | /**
|
1995 | * column in the source file, 1-indexed
|
1996 | */
|
1997 | column: number;
|
1998 | /**
|
1999 | * offset character in the source file, 0-indexed
|
2000 | */
|
2001 | offset?: number;
|
2002 | };
|
2003 | /**
|
2004 | * place of first character after parsed source region, whether it exists or not
|
2005 | */
|
2006 | end: {
|
2007 | /**
|
2008 | * line in the source file, 1-indexed
|
2009 | */
|
2010 | line: number;
|
2011 | /**
|
2012 | * column in the source file, 1-indexed
|
2013 | */
|
2014 | column: number;
|
2015 | /**
|
2016 | * offset character in the source file, 0-indexed
|
2017 | */
|
2018 | offset?: number;
|
2019 | };
|
2020 | /**
|
2021 | * start column at each index in the source region, for elements that span multiple lines
|
2022 | */
|
2023 | indent?: number[];
|
2024 | };
|
2025 | }) & {
|
2026 | /**
|
2027 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
2028 | */
|
2029 | identifier?: string;
|
2030 | /**
|
2031 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
2032 | */
|
2033 | label?: string;
|
2034 | };
|
2035 | export type ThematicBreak = {
|
2036 | type?: "thematicBreak";
|
2037 | position?: unknown;
|
2038 | data?: unknown;
|
2039 | } & {
|
2040 | /**
|
2041 | * identifier for node variant
|
2042 | */
|
2043 | type: string;
|
2044 | /**
|
2045 | * information associated by the ecosystem with the node; never specified by mdast
|
2046 | */
|
2047 | data?: {
|
2048 | [k: string]: unknown;
|
2049 | };
|
2050 | /**
|
2051 | * location of node in source file; must not be present for generated nodes
|
2052 | */
|
2053 | position?: {
|
2054 | /**
|
2055 | * place of first character of parsed source region
|
2056 | */
|
2057 | start: {
|
2058 | /**
|
2059 | * line in the source file, 1-indexed
|
2060 | */
|
2061 | line: number;
|
2062 | /**
|
2063 | * column in the source file, 1-indexed
|
2064 | */
|
2065 | column: number;
|
2066 | /**
|
2067 | * offset character in the source file, 0-indexed
|
2068 | */
|
2069 | offset?: number;
|
2070 | };
|
2071 | /**
|
2072 | * place of first character after parsed source region, whether it exists or not
|
2073 | */
|
2074 | end: {
|
2075 | /**
|
2076 | * line in the source file, 1-indexed
|
2077 | */
|
2078 | line: number;
|
2079 | /**
|
2080 | * column in the source file, 1-indexed
|
2081 | */
|
2082 | column: number;
|
2083 | /**
|
2084 | * offset character in the source file, 0-indexed
|
2085 | */
|
2086 | offset?: number;
|
2087 | };
|
2088 | /**
|
2089 | * start column at each index in the source region, for elements that span multiple lines
|
2090 | */
|
2091 | indent?: number[];
|
2092 | };
|
2093 | };
|
2094 | export type Blockquote = {
|
2095 | type?: "blockquote";
|
2096 | children?: FlowContent[];
|
2097 | position?: unknown;
|
2098 | data?: unknown;
|
2099 | } & ({
|
2100 | /**
|
2101 | * List of children nodes
|
2102 | */
|
2103 | children: Node[];
|
2104 | } & {
|
2105 | /**
|
2106 | * identifier for node variant
|
2107 | */
|
2108 | type: string;
|
2109 | /**
|
2110 | * information associated by the ecosystem with the node; never specified by mdast
|
2111 | */
|
2112 | data?: {
|
2113 | [k: string]: unknown;
|
2114 | };
|
2115 | /**
|
2116 | * location of node in source file; must not be present for generated nodes
|
2117 | */
|
2118 | position?: {
|
2119 | /**
|
2120 | * place of first character of parsed source region
|
2121 | */
|
2122 | start: {
|
2123 | /**
|
2124 | * line in the source file, 1-indexed
|
2125 | */
|
2126 | line: number;
|
2127 | /**
|
2128 | * column in the source file, 1-indexed
|
2129 | */
|
2130 | column: number;
|
2131 | /**
|
2132 | * offset character in the source file, 0-indexed
|
2133 | */
|
2134 | offset?: number;
|
2135 | };
|
2136 | /**
|
2137 | * place of first character after parsed source region, whether it exists or not
|
2138 | */
|
2139 | end: {
|
2140 | /**
|
2141 | * line in the source file, 1-indexed
|
2142 | */
|
2143 | line: number;
|
2144 | /**
|
2145 | * column in the source file, 1-indexed
|
2146 | */
|
2147 | column: number;
|
2148 | /**
|
2149 | * offset character in the source file, 0-indexed
|
2150 | */
|
2151 | offset?: number;
|
2152 | };
|
2153 | /**
|
2154 | * start column at each index in the source region, for elements that span multiple lines
|
2155 | */
|
2156 | indent?: number[];
|
2157 | };
|
2158 | });
|
2159 | export type List = {
|
2160 | type?: "list";
|
2161 | /**
|
2162 | * Is item order important or not?
|
2163 | */
|
2164 | ordered?: boolean;
|
2165 | /**
|
2166 | * Starting number of ordered list
|
2167 | */
|
2168 | start?: number;
|
2169 | /**
|
2170 | * One or more children are separated with a blank line from others
|
2171 | */
|
2172 | spread?: boolean;
|
2173 | children?: ListContent[];
|
2174 | position?: unknown;
|
2175 | data?: unknown;
|
2176 | } & ({
|
2177 | /**
|
2178 | * List of children nodes
|
2179 | */
|
2180 | children: Node[];
|
2181 | } & {
|
2182 | /**
|
2183 | * identifier for node variant
|
2184 | */
|
2185 | type: string;
|
2186 | /**
|
2187 | * information associated by the ecosystem with the node; never specified by mdast
|
2188 | */
|
2189 | data?: {
|
2190 | [k: string]: unknown;
|
2191 | };
|
2192 | /**
|
2193 | * location of node in source file; must not be present for generated nodes
|
2194 | */
|
2195 | position?: {
|
2196 | /**
|
2197 | * place of first character of parsed source region
|
2198 | */
|
2199 | start: {
|
2200 | /**
|
2201 | * line in the source file, 1-indexed
|
2202 | */
|
2203 | line: number;
|
2204 | /**
|
2205 | * column in the source file, 1-indexed
|
2206 | */
|
2207 | column: number;
|
2208 | /**
|
2209 | * offset character in the source file, 0-indexed
|
2210 | */
|
2211 | offset?: number;
|
2212 | };
|
2213 | /**
|
2214 | * place of first character after parsed source region, whether it exists or not
|
2215 | */
|
2216 | end: {
|
2217 | /**
|
2218 | * line in the source file, 1-indexed
|
2219 | */
|
2220 | line: number;
|
2221 | /**
|
2222 | * column in the source file, 1-indexed
|
2223 | */
|
2224 | column: number;
|
2225 | /**
|
2226 | * offset character in the source file, 0-indexed
|
2227 | */
|
2228 | offset?: number;
|
2229 | };
|
2230 | /**
|
2231 | * start column at each index in the source region, for elements that span multiple lines
|
2232 | */
|
2233 | indent?: number[];
|
2234 | };
|
2235 | });
|
2236 | export type ListContent = ListItem;
|
2237 | export type ListItem = {
|
2238 | type?: "listItem";
|
2239 | /**
|
2240 | * One or more children are separated with a blank line from others
|
2241 | */
|
2242 | spread?: boolean;
|
2243 | children?: (PhrasingContent | FlowContent)[];
|
2244 | position?: unknown;
|
2245 | data?: unknown;
|
2246 | } & ({
|
2247 | /**
|
2248 | * List of children nodes
|
2249 | */
|
2250 | children: Node[];
|
2251 | } & {
|
2252 | /**
|
2253 | * identifier for node variant
|
2254 | */
|
2255 | type: string;
|
2256 | /**
|
2257 | * information associated by the ecosystem with the node; never specified by mdast
|
2258 | */
|
2259 | data?: {
|
2260 | [k: string]: unknown;
|
2261 | };
|
2262 | /**
|
2263 | * location of node in source file; must not be present for generated nodes
|
2264 | */
|
2265 | position?: {
|
2266 | /**
|
2267 | * place of first character of parsed source region
|
2268 | */
|
2269 | start: {
|
2270 | /**
|
2271 | * line in the source file, 1-indexed
|
2272 | */
|
2273 | line: number;
|
2274 | /**
|
2275 | * column in the source file, 1-indexed
|
2276 | */
|
2277 | column: number;
|
2278 | /**
|
2279 | * offset character in the source file, 0-indexed
|
2280 | */
|
2281 | offset?: number;
|
2282 | };
|
2283 | /**
|
2284 | * place of first character after parsed source region, whether it exists or not
|
2285 | */
|
2286 | end: {
|
2287 | /**
|
2288 | * line in the source file, 1-indexed
|
2289 | */
|
2290 | line: number;
|
2291 | /**
|
2292 | * column in the source file, 1-indexed
|
2293 | */
|
2294 | column: number;
|
2295 | /**
|
2296 | * offset character in the source file, 0-indexed
|
2297 | */
|
2298 | offset?: number;
|
2299 | };
|
2300 | /**
|
2301 | * start column at each index in the source region, for elements that span multiple lines
|
2302 | */
|
2303 | indent?: number[];
|
2304 | };
|
2305 | });
|
2306 | /**
|
2307 | * Block of preformatted text
|
2308 | */
|
2309 | export type Code = {
|
2310 | type?: "code";
|
2311 | /**
|
2312 | * language of the code
|
2313 | */
|
2314 | lang?: string;
|
2315 | /**
|
2316 | * custom information relating to the node
|
2317 | */
|
2318 | meta?: string;
|
2319 | /**
|
2320 | * user-defined class for code block
|
2321 | */
|
2322 | class?: string;
|
2323 | showLineNumbers?: boolean;
|
2324 | startingLineNumber?: number;
|
2325 | emphasizeLines?: number[];
|
2326 | identifier?: unknown;
|
2327 | label?: unknown;
|
2328 | value?: unknown;
|
2329 | position?: unknown;
|
2330 | data?: unknown;
|
2331 | } & {} & {} & {
|
2332 | /**
|
2333 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
2334 | */
|
2335 | identifier?: string;
|
2336 | /**
|
2337 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
2338 | */
|
2339 | label?: string;
|
2340 | } & ({
|
2341 | /**
|
2342 | * The value of the node
|
2343 | */
|
2344 | value: string;
|
2345 | } & {
|
2346 | /**
|
2347 | * identifier for node variant
|
2348 | */
|
2349 | type: string;
|
2350 | /**
|
2351 | * information associated by the ecosystem with the node; never specified by mdast
|
2352 | */
|
2353 | data?: {
|
2354 | [k: string]: unknown;
|
2355 | };
|
2356 | /**
|
2357 | * location of node in source file; must not be present for generated nodes
|
2358 | */
|
2359 | position?: {
|
2360 | /**
|
2361 | * place of first character of parsed source region
|
2362 | */
|
2363 | start: {
|
2364 | /**
|
2365 | * line in the source file, 1-indexed
|
2366 | */
|
2367 | line: number;
|
2368 | /**
|
2369 | * column in the source file, 1-indexed
|
2370 | */
|
2371 | column: number;
|
2372 | /**
|
2373 | * offset character in the source file, 0-indexed
|
2374 | */
|
2375 | offset?: number;
|
2376 | };
|
2377 | /**
|
2378 | * place of first character after parsed source region, whether it exists or not
|
2379 | */
|
2380 | end: {
|
2381 | /**
|
2382 | * line in the source file, 1-indexed
|
2383 | */
|
2384 | line: number;
|
2385 | /**
|
2386 | * column in the source file, 1-indexed
|
2387 | */
|
2388 | column: number;
|
2389 | /**
|
2390 | * offset character in the source file, 0-indexed
|
2391 | */
|
2392 | offset?: number;
|
2393 | };
|
2394 | /**
|
2395 | * start column at each index in the source region, for elements that span multiple lines
|
2396 | */
|
2397 | indent?: number[];
|
2398 | };
|
2399 | });
|
2400 | /**
|
2401 | * Comment nodes for comments present in myst but ignored upon render
|
2402 | */
|
2403 | export type Comment = {
|
2404 | type?: "mystComment";
|
2405 | value?: unknown;
|
2406 | position?: unknown;
|
2407 | data?: unknown;
|
2408 | } & ({
|
2409 | /**
|
2410 | * The value of the node
|
2411 | */
|
2412 | value: string;
|
2413 | } & {
|
2414 | /**
|
2415 | * identifier for node variant
|
2416 | */
|
2417 | type: string;
|
2418 | /**
|
2419 | * information associated by the ecosystem with the node; never specified by mdast
|
2420 | */
|
2421 | data?: {
|
2422 | [k: string]: unknown;
|
2423 | };
|
2424 | /**
|
2425 | * location of node in source file; must not be present for generated nodes
|
2426 | */
|
2427 | position?: {
|
2428 | /**
|
2429 | * place of first character of parsed source region
|
2430 | */
|
2431 | start: {
|
2432 | /**
|
2433 | * line in the source file, 1-indexed
|
2434 | */
|
2435 | line: number;
|
2436 | /**
|
2437 | * column in the source file, 1-indexed
|
2438 | */
|
2439 | column: number;
|
2440 | /**
|
2441 | * offset character in the source file, 0-indexed
|
2442 | */
|
2443 | offset?: number;
|
2444 | };
|
2445 | /**
|
2446 | * place of first character after parsed source region, whether it exists or not
|
2447 | */
|
2448 | end: {
|
2449 | /**
|
2450 | * line in the source file, 1-indexed
|
2451 | */
|
2452 | line: number;
|
2453 | /**
|
2454 | * column in the source file, 1-indexed
|
2455 | */
|
2456 | column: number;
|
2457 | /**
|
2458 | * offset character in the source file, 0-indexed
|
2459 | */
|
2460 | offset?: number;
|
2461 | };
|
2462 | /**
|
2463 | * start column at each index in the source region, for elements that span multiple lines
|
2464 | */
|
2465 | indent?: number[];
|
2466 | };
|
2467 | });
|
2468 | /**
|
2469 | * Target node - provides identifier/label for the following node
|
2470 | */
|
2471 | export type Target = {
|
2472 | type?: "mystTarget";
|
2473 | /**
|
2474 | * unresolved target label
|
2475 | */
|
2476 | label?: string;
|
2477 | position?: unknown;
|
2478 | data?: unknown;
|
2479 | } & {
|
2480 | /**
|
2481 | * identifier for node variant
|
2482 | */
|
2483 | type: string;
|
2484 | /**
|
2485 | * information associated by the ecosystem with the node; never specified by mdast
|
2486 | */
|
2487 | data?: {
|
2488 | [k: string]: unknown;
|
2489 | };
|
2490 | /**
|
2491 | * location of node in source file; must not be present for generated nodes
|
2492 | */
|
2493 | position?: {
|
2494 | /**
|
2495 | * place of first character of parsed source region
|
2496 | */
|
2497 | start: {
|
2498 | /**
|
2499 | * line in the source file, 1-indexed
|
2500 | */
|
2501 | line: number;
|
2502 | /**
|
2503 | * column in the source file, 1-indexed
|
2504 | */
|
2505 | column: number;
|
2506 | /**
|
2507 | * offset character in the source file, 0-indexed
|
2508 | */
|
2509 | offset?: number;
|
2510 | };
|
2511 | /**
|
2512 | * place of first character after parsed source region, whether it exists or not
|
2513 | */
|
2514 | end: {
|
2515 | /**
|
2516 | * line in the source file, 1-indexed
|
2517 | */
|
2518 | line: number;
|
2519 | /**
|
2520 | * column in the source file, 1-indexed
|
2521 | */
|
2522 | column: number;
|
2523 | /**
|
2524 | * offset character in the source file, 0-indexed
|
2525 | */
|
2526 | offset?: number;
|
2527 | };
|
2528 | /**
|
2529 | * start column at each index in the source region, for elements that span multiple lines
|
2530 | */
|
2531 | indent?: number[];
|
2532 | };
|
2533 | };
|
2534 | /**
|
2535 | * Content block with predefined behavior
|
2536 | */
|
2537 | export type Directive = {
|
2538 | type?: "mystDirective";
|
2539 | name: string;
|
2540 | args?: string;
|
2541 | options?: {
|
2542 | [k: string]: unknown;
|
2543 | };
|
2544 | /**
|
2545 | * body of the directive, excluding options
|
2546 | */
|
2547 | value?: string;
|
2548 | /**
|
2549 | * parsed directive content
|
2550 | */
|
2551 | children?: (FlowContent | PhrasingContent)[];
|
2552 | position?: unknown;
|
2553 | data?: unknown;
|
2554 | } & {
|
2555 | /**
|
2556 | * identifier for node variant
|
2557 | */
|
2558 | type: string;
|
2559 | /**
|
2560 | * information associated by the ecosystem with the node; never specified by mdast
|
2561 | */
|
2562 | data?: {
|
2563 | [k: string]: unknown;
|
2564 | };
|
2565 | /**
|
2566 | * location of node in source file; must not be present for generated nodes
|
2567 | */
|
2568 | position?: {
|
2569 | /**
|
2570 | * place of first character of parsed source region
|
2571 | */
|
2572 | start: {
|
2573 | /**
|
2574 | * line in the source file, 1-indexed
|
2575 | */
|
2576 | line: number;
|
2577 | /**
|
2578 | * column in the source file, 1-indexed
|
2579 | */
|
2580 | column: number;
|
2581 | /**
|
2582 | * offset character in the source file, 0-indexed
|
2583 | */
|
2584 | offset?: number;
|
2585 | };
|
2586 | /**
|
2587 | * place of first character after parsed source region, whether it exists or not
|
2588 | */
|
2589 | end: {
|
2590 | /**
|
2591 | * line in the source file, 1-indexed
|
2592 | */
|
2593 | line: number;
|
2594 | /**
|
2595 | * column in the source file, 1-indexed
|
2596 | */
|
2597 | column: number;
|
2598 | /**
|
2599 | * offset character in the source file, 0-indexed
|
2600 | */
|
2601 | offset?: number;
|
2602 | };
|
2603 | /**
|
2604 | * start column at each index in the source region, for elements that span multiple lines
|
2605 | */
|
2606 | indent?: number[];
|
2607 | };
|
2608 | };
|
2609 | /**
|
2610 | * Admonition node for drawing attention to text, separate from the neighboring content
|
2611 | */
|
2612 | export type Admonition = {
|
2613 | type?: "admonition";
|
2614 | /**
|
2615 | * kind of admonition, to determine styling
|
2616 | */
|
2617 | kind?: "attention" | "caution" | "danger" | "error" | "hint" | "important" | "note" | "seealso" | "tip" | "warning";
|
2618 | /**
|
2619 | * admonition class info to override kind
|
2620 | */
|
2621 | class?: string;
|
2622 | /**
|
2623 | * An optional `admonitionTitle` followed by the admonitions content.
|
2624 | */
|
2625 | children?: (AdmonitionTitle | FlowContent)[];
|
2626 | position?: unknown;
|
2627 | data?: unknown;
|
2628 | } & {
|
2629 | /**
|
2630 | * identifier for node variant
|
2631 | */
|
2632 | type: string;
|
2633 | /**
|
2634 | * information associated by the ecosystem with the node; never specified by mdast
|
2635 | */
|
2636 | data?: {
|
2637 | [k: string]: unknown;
|
2638 | };
|
2639 | /**
|
2640 | * location of node in source file; must not be present for generated nodes
|
2641 | */
|
2642 | position?: {
|
2643 | /**
|
2644 | * place of first character of parsed source region
|
2645 | */
|
2646 | start: {
|
2647 | /**
|
2648 | * line in the source file, 1-indexed
|
2649 | */
|
2650 | line: number;
|
2651 | /**
|
2652 | * column in the source file, 1-indexed
|
2653 | */
|
2654 | column: number;
|
2655 | /**
|
2656 | * offset character in the source file, 0-indexed
|
2657 | */
|
2658 | offset?: number;
|
2659 | };
|
2660 | /**
|
2661 | * place of first character after parsed source region, whether it exists or not
|
2662 | */
|
2663 | end: {
|
2664 | /**
|
2665 | * line in the source file, 1-indexed
|
2666 | */
|
2667 | line: number;
|
2668 | /**
|
2669 | * column in the source file, 1-indexed
|
2670 | */
|
2671 | column: number;
|
2672 | /**
|
2673 | * offset character in the source file, 0-indexed
|
2674 | */
|
2675 | offset?: number;
|
2676 | };
|
2677 | /**
|
2678 | * start column at each index in the source region, for elements that span multiple lines
|
2679 | */
|
2680 | indent?: number[];
|
2681 | };
|
2682 | };
|
2683 | /**
|
2684 | * Custom title for admonition, replaces kind as title
|
2685 | */
|
2686 | export type AdmonitionTitle = {
|
2687 | type?: "admonitionTitle";
|
2688 | children?: PhrasingContent[];
|
2689 | position?: unknown;
|
2690 | data?: unknown;
|
2691 | } & ({
|
2692 | /**
|
2693 | * List of children nodes
|
2694 | */
|
2695 | children: Node[];
|
2696 | } & {
|
2697 | /**
|
2698 | * identifier for node variant
|
2699 | */
|
2700 | type: string;
|
2701 | /**
|
2702 | * information associated by the ecosystem with the node; never specified by mdast
|
2703 | */
|
2704 | data?: {
|
2705 | [k: string]: unknown;
|
2706 | };
|
2707 | /**
|
2708 | * location of node in source file; must not be present for generated nodes
|
2709 | */
|
2710 | position?: {
|
2711 | /**
|
2712 | * place of first character of parsed source region
|
2713 | */
|
2714 | start: {
|
2715 | /**
|
2716 | * line in the source file, 1-indexed
|
2717 | */
|
2718 | line: number;
|
2719 | /**
|
2720 | * column in the source file, 1-indexed
|
2721 | */
|
2722 | column: number;
|
2723 | /**
|
2724 | * offset character in the source file, 0-indexed
|
2725 | */
|
2726 | offset?: number;
|
2727 | };
|
2728 | /**
|
2729 | * place of first character after parsed source region, whether it exists or not
|
2730 | */
|
2731 | end: {
|
2732 | /**
|
2733 | * line in the source file, 1-indexed
|
2734 | */
|
2735 | line: number;
|
2736 | /**
|
2737 | * column in the source file, 1-indexed
|
2738 | */
|
2739 | column: number;
|
2740 | /**
|
2741 | * offset character in the source file, 0-indexed
|
2742 | */
|
2743 | offset?: number;
|
2744 | };
|
2745 | /**
|
2746 | * start column at each index in the source region, for elements that span multiple lines
|
2747 | */
|
2748 | indent?: number[];
|
2749 | };
|
2750 | });
|
2751 | /**
|
2752 | * Top-level container node to provide association and numbering to child content
|
2753 | */
|
2754 | export type Container = {
|
2755 | type?: "container";
|
2756 | /**
|
2757 | * kind of container contents
|
2758 | */
|
2759 | kind: "figure" | "table";
|
2760 | /**
|
2761 | * any custom class information
|
2762 | */
|
2763 | class?: string;
|
2764 | /**
|
2765 | * count this container for numbering based on kind, e.g. Figure 1a
|
2766 | */
|
2767 | enumerated?: boolean;
|
2768 | /**
|
2769 | * resolved enumerated value for this container
|
2770 | */
|
2771 | enumerator?: string;
|
2772 | children?: (Caption | Legend | Image | Table)[];
|
2773 | identifier?: unknown;
|
2774 | label?: unknown;
|
2775 | position?: unknown;
|
2776 | data?: unknown;
|
2777 | } & {} & {
|
2778 | /**
|
2779 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
2780 | */
|
2781 | identifier?: string;
|
2782 | /**
|
2783 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
2784 | */
|
2785 | label?: string;
|
2786 | } & ({
|
2787 | /**
|
2788 | * List of children nodes
|
2789 | */
|
2790 | children: Node[];
|
2791 | } & {
|
2792 | /**
|
2793 | * identifier for node variant
|
2794 | */
|
2795 | type: string;
|
2796 | /**
|
2797 | * information associated by the ecosystem with the node; never specified by mdast
|
2798 | */
|
2799 | data?: {
|
2800 | [k: string]: unknown;
|
2801 | };
|
2802 | /**
|
2803 | * location of node in source file; must not be present for generated nodes
|
2804 | */
|
2805 | position?: {
|
2806 | /**
|
2807 | * place of first character of parsed source region
|
2808 | */
|
2809 | start: {
|
2810 | /**
|
2811 | * line in the source file, 1-indexed
|
2812 | */
|
2813 | line: number;
|
2814 | /**
|
2815 | * column in the source file, 1-indexed
|
2816 | */
|
2817 | column: number;
|
2818 | /**
|
2819 | * offset character in the source file, 0-indexed
|
2820 | */
|
2821 | offset?: number;
|
2822 | };
|
2823 | /**
|
2824 | * place of first character after parsed source region, whether it exists or not
|
2825 | */
|
2826 | end: {
|
2827 | /**
|
2828 | * line in the source file, 1-indexed
|
2829 | */
|
2830 | line: number;
|
2831 | /**
|
2832 | * column in the source file, 1-indexed
|
2833 | */
|
2834 | column: number;
|
2835 | /**
|
2836 | * offset character in the source file, 0-indexed
|
2837 | */
|
2838 | offset?: number;
|
2839 | };
|
2840 | /**
|
2841 | * start column at each index in the source region, for elements that span multiple lines
|
2842 | */
|
2843 | indent?: number[];
|
2844 | };
|
2845 | });
|
2846 | /**
|
2847 | * Caption for container content
|
2848 | */
|
2849 | export type Caption = {
|
2850 | type?: "caption";
|
2851 | children?: FlowContent[];
|
2852 | position?: unknown;
|
2853 | data?: unknown;
|
2854 | } & ({
|
2855 | /**
|
2856 | * List of children nodes
|
2857 | */
|
2858 | children: Node[];
|
2859 | } & {
|
2860 | /**
|
2861 | * identifier for node variant
|
2862 | */
|
2863 | type: string;
|
2864 | /**
|
2865 | * information associated by the ecosystem with the node; never specified by mdast
|
2866 | */
|
2867 | data?: {
|
2868 | [k: string]: unknown;
|
2869 | };
|
2870 | /**
|
2871 | * location of node in source file; must not be present for generated nodes
|
2872 | */
|
2873 | position?: {
|
2874 | /**
|
2875 | * place of first character of parsed source region
|
2876 | */
|
2877 | start: {
|
2878 | /**
|
2879 | * line in the source file, 1-indexed
|
2880 | */
|
2881 | line: number;
|
2882 | /**
|
2883 | * column in the source file, 1-indexed
|
2884 | */
|
2885 | column: number;
|
2886 | /**
|
2887 | * offset character in the source file, 0-indexed
|
2888 | */
|
2889 | offset?: number;
|
2890 | };
|
2891 | /**
|
2892 | * place of first character after parsed source region, whether it exists or not
|
2893 | */
|
2894 | end: {
|
2895 | /**
|
2896 | * line in the source file, 1-indexed
|
2897 | */
|
2898 | line: number;
|
2899 | /**
|
2900 | * column in the source file, 1-indexed
|
2901 | */
|
2902 | column: number;
|
2903 | /**
|
2904 | * offset character in the source file, 0-indexed
|
2905 | */
|
2906 | offset?: number;
|
2907 | };
|
2908 | /**
|
2909 | * start column at each index in the source region, for elements that span multiple lines
|
2910 | */
|
2911 | indent?: number[];
|
2912 | };
|
2913 | });
|
2914 | /**
|
2915 | * Legend for container content
|
2916 | */
|
2917 | export type Legend = {
|
2918 | type?: "legend";
|
2919 | children?: FlowContent[];
|
2920 | position?: unknown;
|
2921 | data?: unknown;
|
2922 | } & ({
|
2923 | /**
|
2924 | * List of children nodes
|
2925 | */
|
2926 | children: Node[];
|
2927 | } & {
|
2928 | /**
|
2929 | * identifier for node variant
|
2930 | */
|
2931 | type: string;
|
2932 | /**
|
2933 | * information associated by the ecosystem with the node; never specified by mdast
|
2934 | */
|
2935 | data?: {
|
2936 | [k: string]: unknown;
|
2937 | };
|
2938 | /**
|
2939 | * location of node in source file; must not be present for generated nodes
|
2940 | */
|
2941 | position?: {
|
2942 | /**
|
2943 | * place of first character of parsed source region
|
2944 | */
|
2945 | start: {
|
2946 | /**
|
2947 | * line in the source file, 1-indexed
|
2948 | */
|
2949 | line: number;
|
2950 | /**
|
2951 | * column in the source file, 1-indexed
|
2952 | */
|
2953 | column: number;
|
2954 | /**
|
2955 | * offset character in the source file, 0-indexed
|
2956 | */
|
2957 | offset?: number;
|
2958 | };
|
2959 | /**
|
2960 | * place of first character after parsed source region, whether it exists or not
|
2961 | */
|
2962 | end: {
|
2963 | /**
|
2964 | * line in the source file, 1-indexed
|
2965 | */
|
2966 | line: number;
|
2967 | /**
|
2968 | * column in the source file, 1-indexed
|
2969 | */
|
2970 | column: number;
|
2971 | /**
|
2972 | * offset character in the source file, 0-indexed
|
2973 | */
|
2974 | offset?: number;
|
2975 | };
|
2976 | /**
|
2977 | * start column at each index in the source region, for elements that span multiple lines
|
2978 | */
|
2979 | indent?: number[];
|
2980 | };
|
2981 | });
|
2982 | /**
|
2983 | * Two-dimensional table data
|
2984 | */
|
2985 | export type Table = {
|
2986 | type?: "table";
|
2987 | align?: "left" | "center" | "right";
|
2988 | children?: TableRow[];
|
2989 | position?: unknown;
|
2990 | data?: unknown;
|
2991 | } & ({
|
2992 | /**
|
2993 | * List of children nodes
|
2994 | */
|
2995 | children: Node[];
|
2996 | } & {
|
2997 | /**
|
2998 | * identifier for node variant
|
2999 | */
|
3000 | type: string;
|
3001 | /**
|
3002 | * information associated by the ecosystem with the node; never specified by mdast
|
3003 | */
|
3004 | data?: {
|
3005 | [k: string]: unknown;
|
3006 | };
|
3007 | /**
|
3008 | * location of node in source file; must not be present for generated nodes
|
3009 | */
|
3010 | position?: {
|
3011 | /**
|
3012 | * place of first character of parsed source region
|
3013 | */
|
3014 | start: {
|
3015 | /**
|
3016 | * line in the source file, 1-indexed
|
3017 | */
|
3018 | line: number;
|
3019 | /**
|
3020 | * column in the source file, 1-indexed
|
3021 | */
|
3022 | column: number;
|
3023 | /**
|
3024 | * offset character in the source file, 0-indexed
|
3025 | */
|
3026 | offset?: number;
|
3027 | };
|
3028 | /**
|
3029 | * place of first character after parsed source region, whether it exists or not
|
3030 | */
|
3031 | end: {
|
3032 | /**
|
3033 | * line in the source file, 1-indexed
|
3034 | */
|
3035 | line: number;
|
3036 | /**
|
3037 | * column in the source file, 1-indexed
|
3038 | */
|
3039 | column: number;
|
3040 | /**
|
3041 | * offset character in the source file, 0-indexed
|
3042 | */
|
3043 | offset?: number;
|
3044 | };
|
3045 | /**
|
3046 | * start column at each index in the source region, for elements that span multiple lines
|
3047 | */
|
3048 | indent?: number[];
|
3049 | };
|
3050 | });
|
3051 | /**
|
3052 | * One row of table containing cells
|
3053 | */
|
3054 | export type TableRow = {
|
3055 | type?: "tableRow";
|
3056 | children?: TableCell[];
|
3057 | position?: unknown;
|
3058 | data?: unknown;
|
3059 | } & ({
|
3060 | /**
|
3061 | * List of children nodes
|
3062 | */
|
3063 | children: Node[];
|
3064 | } & {
|
3065 | /**
|
3066 | * identifier for node variant
|
3067 | */
|
3068 | type: string;
|
3069 | /**
|
3070 | * information associated by the ecosystem with the node; never specified by mdast
|
3071 | */
|
3072 | data?: {
|
3073 | [k: string]: unknown;
|
3074 | };
|
3075 | /**
|
3076 | * location of node in source file; must not be present for generated nodes
|
3077 | */
|
3078 | position?: {
|
3079 | /**
|
3080 | * place of first character of parsed source region
|
3081 | */
|
3082 | start: {
|
3083 | /**
|
3084 | * line in the source file, 1-indexed
|
3085 | */
|
3086 | line: number;
|
3087 | /**
|
3088 | * column in the source file, 1-indexed
|
3089 | */
|
3090 | column: number;
|
3091 | /**
|
3092 | * offset character in the source file, 0-indexed
|
3093 | */
|
3094 | offset?: number;
|
3095 | };
|
3096 | /**
|
3097 | * place of first character after parsed source region, whether it exists or not
|
3098 | */
|
3099 | end: {
|
3100 | /**
|
3101 | * line in the source file, 1-indexed
|
3102 | */
|
3103 | line: number;
|
3104 | /**
|
3105 | * column in the source file, 1-indexed
|
3106 | */
|
3107 | column: number;
|
3108 | /**
|
3109 | * offset character in the source file, 0-indexed
|
3110 | */
|
3111 | offset?: number;
|
3112 | };
|
3113 | /**
|
3114 | * start column at each index in the source region, for elements that span multiple lines
|
3115 | */
|
3116 | indent?: number[];
|
3117 | };
|
3118 | });
|
3119 | /**
|
3120 | * One cell of table
|
3121 | */
|
3122 | export type TableCell = {
|
3123 | type?: "tableCell";
|
3124 | header?: boolean;
|
3125 | /**
|
3126 | * alignment of content within cell
|
3127 | */
|
3128 | align?: "left" | "center" | "right";
|
3129 | children?: PhrasingContent[];
|
3130 | position?: unknown;
|
3131 | data?: unknown;
|
3132 | } & ({
|
3133 | /**
|
3134 | * List of children nodes
|
3135 | */
|
3136 | children: Node[];
|
3137 | } & {
|
3138 | /**
|
3139 | * identifier for node variant
|
3140 | */
|
3141 | type: string;
|
3142 | /**
|
3143 | * information associated by the ecosystem with the node; never specified by mdast
|
3144 | */
|
3145 | data?: {
|
3146 | [k: string]: unknown;
|
3147 | };
|
3148 | /**
|
3149 | * location of node in source file; must not be present for generated nodes
|
3150 | */
|
3151 | position?: {
|
3152 | /**
|
3153 | * place of first character of parsed source region
|
3154 | */
|
3155 | start: {
|
3156 | /**
|
3157 | * line in the source file, 1-indexed
|
3158 | */
|
3159 | line: number;
|
3160 | /**
|
3161 | * column in the source file, 1-indexed
|
3162 | */
|
3163 | column: number;
|
3164 | /**
|
3165 | * offset character in the source file, 0-indexed
|
3166 | */
|
3167 | offset?: number;
|
3168 | };
|
3169 | /**
|
3170 | * place of first character after parsed source region, whether it exists or not
|
3171 | */
|
3172 | end: {
|
3173 | /**
|
3174 | * line in the source file, 1-indexed
|
3175 | */
|
3176 | line: number;
|
3177 | /**
|
3178 | * column in the source file, 1-indexed
|
3179 | */
|
3180 | column: number;
|
3181 | /**
|
3182 | * offset character in the source file, 0-indexed
|
3183 | */
|
3184 | offset?: number;
|
3185 | };
|
3186 | /**
|
3187 | * start column at each index in the source region, for elements that span multiple lines
|
3188 | */
|
3189 | indent?: number[];
|
3190 | };
|
3191 | });
|
3192 | /**
|
3193 | * Math node for presenting numbered equations
|
3194 | */
|
3195 | export type Math = {
|
3196 | type?: "math";
|
3197 | /**
|
3198 | * count this math block for numbering based on kind, e.g. See equation (1a)
|
3199 | */
|
3200 | enumerated?: boolean;
|
3201 | /**
|
3202 | * resolved enumerated value for this math block
|
3203 | */
|
3204 | enumerator?: string;
|
3205 | identifier?: unknown;
|
3206 | label?: unknown;
|
3207 | value?: unknown;
|
3208 | position?: unknown;
|
3209 | data?: unknown;
|
3210 | } & {
|
3211 | /**
|
3212 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
3213 | */
|
3214 | identifier?: string;
|
3215 | /**
|
3216 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
3217 | */
|
3218 | label?: string;
|
3219 | } & ({
|
3220 | /**
|
3221 | * The value of the node
|
3222 | */
|
3223 | value: string;
|
3224 | } & {
|
3225 | /**
|
3226 | * identifier for node variant
|
3227 | */
|
3228 | type: string;
|
3229 | /**
|
3230 | * information associated by the ecosystem with the node; never specified by mdast
|
3231 | */
|
3232 | data?: {
|
3233 | [k: string]: unknown;
|
3234 | };
|
3235 | /**
|
3236 | * location of node in source file; must not be present for generated nodes
|
3237 | */
|
3238 | position?: {
|
3239 | /**
|
3240 | * place of first character of parsed source region
|
3241 | */
|
3242 | start: {
|
3243 | /**
|
3244 | * line in the source file, 1-indexed
|
3245 | */
|
3246 | line: number;
|
3247 | /**
|
3248 | * column in the source file, 1-indexed
|
3249 | */
|
3250 | column: number;
|
3251 | /**
|
3252 | * offset character in the source file, 0-indexed
|
3253 | */
|
3254 | offset?: number;
|
3255 | };
|
3256 | /**
|
3257 | * place of first character after parsed source region, whether it exists or not
|
3258 | */
|
3259 | end: {
|
3260 | /**
|
3261 | * line in the source file, 1-indexed
|
3262 | */
|
3263 | line: number;
|
3264 | /**
|
3265 | * column in the source file, 1-indexed
|
3266 | */
|
3267 | column: number;
|
3268 | /**
|
3269 | * offset character in the source file, 0-indexed
|
3270 | */
|
3271 | offset?: number;
|
3272 | };
|
3273 | /**
|
3274 | * start column at each index in the source region, for elements that span multiple lines
|
3275 | */
|
3276 | indent?: number[];
|
3277 | };
|
3278 | });
|
3279 | /**
|
3280 | * Rich footnote content associated with footnote reference
|
3281 | */
|
3282 | export type FootnoteDefinition = {
|
3283 | type?: "footnoteDefinition";
|
3284 | children?: FlowContent[];
|
3285 | identifier?: unknown;
|
3286 | label?: unknown;
|
3287 | position?: unknown;
|
3288 | data?: unknown;
|
3289 | } & ({
|
3290 | identifier: unknown;
|
3291 | } & {
|
3292 | /**
|
3293 | * identifier that may match another node; value is unparsed and must be normalized such that whitespace is collapsed to single space, initial/final space is trimmed, and case is folded
|
3294 | */
|
3295 | identifier?: string;
|
3296 | /**
|
3297 | * node label; character escapes and references are parsed; may be normalized to a unique identifier
|
3298 | */
|
3299 | label?: string;
|
3300 | }) &
|
3301 | ({
|
3302 | /**
|
3303 | * List of children nodes
|
3304 | */
|
3305 | children: Node[];
|
3306 | } & {
|
3307 | /**
|
3308 | * identifier for node variant
|
3309 | */
|
3310 | type: string;
|
3311 | /**
|
3312 | * information associated by the ecosystem with the node; never specified by mdast
|
3313 | */
|
3314 | data?: {
|
3315 | [k: string]: unknown;
|
3316 | };
|
3317 | /**
|
3318 | * location of node in source file; must not be present for generated nodes
|
3319 | */
|
3320 | position?: {
|
3321 | /**
|
3322 | * place of first character of parsed source region
|
3323 | */
|
3324 | start: {
|
3325 | /**
|
3326 | * line in the source file, 1-indexed
|
3327 | */
|
3328 | line: number;
|
3329 | /**
|
3330 | * column in the source file, 1-indexed
|
3331 | */
|
3332 | column: number;
|
3333 | /**
|
3334 | * offset character in the source file, 0-indexed
|
3335 | */
|
3336 | offset?: number;
|
3337 | };
|
3338 | /**
|
3339 | * place of first character after parsed source region, whether it exists or not
|
3340 | */
|
3341 | end: {
|
3342 | /**
|
3343 | * line in the source file, 1-indexed
|
3344 | */
|
3345 | line: number;
|
3346 | /**
|
3347 | * column in the source file, 1-indexed
|
3348 | */
|
3349 | column: number;
|
3350 | /**
|
3351 | * offset character in the source file, 0-indexed
|
3352 | */
|
3353 | offset?: number;
|
3354 | };
|
3355 | /**
|
3356 | * start column at each index in the source region, for elements that span multiple lines
|
3357 | */
|
3358 | indent?: number[];
|
3359 | };
|
3360 | });
|
3361 | /**
|
3362 | * Top-level break in the myst document, breaking it into Blocks
|
3363 | */
|
3364 | export type BlockBreak = {
|
3365 | type?: "blockBreak";
|
3366 | /**
|
3367 | * Block metadata. Conventionally this is a stringified JSON dictionary but it may be any arbitrary string.
|
3368 | */
|
3369 | meta?: string;
|
3370 | position?: unknown;
|
3371 | data?: unknown;
|
3372 | } & {
|
3373 | /**
|
3374 | * identifier for node variant
|
3375 | */
|
3376 | type: string;
|
3377 | /**
|
3378 | * information associated by the ecosystem with the node; never specified by mdast
|
3379 | */
|
3380 | data?: {
|
3381 | [k: string]: unknown;
|
3382 | };
|
3383 | /**
|
3384 | * location of node in source file; must not be present for generated nodes
|
3385 | */
|
3386 | position?: {
|
3387 | /**
|
3388 | * place of first character of parsed source region
|
3389 | */
|
3390 | start: {
|
3391 | /**
|
3392 | * line in the source file, 1-indexed
|
3393 | */
|
3394 | line: number;
|
3395 | /**
|
3396 | * column in the source file, 1-indexed
|
3397 | */
|
3398 | column: number;
|
3399 | /**
|
3400 | * offset character in the source file, 0-indexed
|
3401 | */
|
3402 | offset?: number;
|
3403 | };
|
3404 | /**
|
3405 | * place of first character after parsed source region, whether it exists or not
|
3406 | */
|
3407 | end: {
|
3408 | /**
|
3409 | * line in the source file, 1-indexed
|
3410 | */
|
3411 | line: number;
|
3412 | /**
|
3413 | * column in the source file, 1-indexed
|
3414 | */
|
3415 | column: number;
|
3416 | /**
|
3417 | * offset character in the source file, 0-indexed
|
3418 | */
|
3419 | offset?: number;
|
3420 | };
|
3421 | /**
|
3422 | * start column at each index in the source region, for elements that span multiple lines
|
3423 | */
|
3424 | indent?: number[];
|
3425 | };
|
3426 | };
|
3427 | /**
|
3428 | * Basic node with required node children
|
3429 | */
|
3430 | export type Parent = {
|
3431 | /**
|
3432 | * List of children nodes
|
3433 | */
|
3434 | children: Node[];
|
3435 | } & {
|
3436 | /**
|
3437 | * identifier for node variant
|
3438 | */
|
3439 | type: string;
|
3440 | /**
|
3441 | * information associated by the ecosystem with the node; never specified by mdast
|
3442 | */
|
3443 | data?: {
|
3444 | [k: string]: unknown;
|
3445 | };
|
3446 | /**
|
3447 | * location of node in source file; must not be present for generated nodes
|
3448 | */
|
3449 | position?: {
|
3450 | /**
|
3451 | * place of first character of parsed source region
|
3452 | */
|
3453 | start: {
|
3454 | /**
|
3455 | * line in the source file, 1-indexed
|
3456 | */
|
3457 | line: number;
|
3458 | /**
|
3459 | * column in the source file, 1-indexed
|
3460 | */
|
3461 | column: number;
|
3462 | /**
|
3463 | * offset character in the source file, 0-indexed
|
3464 | */
|
3465 | offset?: number;
|
3466 | };
|
3467 | /**
|
3468 | * place of first character after parsed source region, whether it exists or not
|
3469 | */
|
3470 | end: {
|
3471 | /**
|
3472 | * line in the source file, 1-indexed
|
3473 | */
|
3474 | line: number;
|
3475 | /**
|
3476 | * column in the source file, 1-indexed
|
3477 | */
|
3478 | column: number;
|
3479 | /**
|
3480 | * offset character in the source file, 0-indexed
|
3481 | */
|
3482 | offset?: number;
|
3483 | };
|
3484 | /**
|
3485 | * start column at each index in the source region, for elements that span multiple lines
|
3486 | */
|
3487 | indent?: number[];
|
3488 | };
|
3489 | };
|
3490 |
|
3491 | /**
|
3492 | * Base node object, based on the [unist](https://github.com/syntax-tree/unist) syntax tree.
|
3493 | */
|
3494 | export interface Node {
|
3495 | /**
|
3496 | * identifier for node variant
|
3497 | */
|
3498 | type: string;
|
3499 | /**
|
3500 | * information associated by the ecosystem with the node; never specified by mdast
|
3501 | */
|
3502 | data?: {
|
3503 | [k: string]: unknown;
|
3504 | };
|
3505 | /**
|
3506 | * location of node in source file; must not be present for generated nodes
|
3507 | */
|
3508 | position?: {
|
3509 | /**
|
3510 | * place of first character of parsed source region
|
3511 | */
|
3512 | start: {
|
3513 | /**
|
3514 | * line in the source file, 1-indexed
|
3515 | */
|
3516 | line: number;
|
3517 | /**
|
3518 | * column in the source file, 1-indexed
|
3519 | */
|
3520 | column: number;
|
3521 | /**
|
3522 | * offset character in the source file, 0-indexed
|
3523 | */
|
3524 | offset?: number;
|
3525 | };
|
3526 | /**
|
3527 | * place of first character after parsed source region, whether it exists or not
|
3528 | */
|
3529 | end: {
|
3530 | /**
|
3531 | * line in the source file, 1-indexed
|
3532 | */
|
3533 | line: number;
|
3534 | /**
|
3535 | * column in the source file, 1-indexed
|
3536 | */
|
3537 | column: number;
|
3538 | /**
|
3539 | * offset character in the source file, 0-indexed
|
3540 | */
|
3541 | offset?: number;
|
3542 | };
|
3543 | /**
|
3544 | * start column at each index in the source region, for elements that span multiple lines
|
3545 | */
|
3546 | indent?: number[];
|
3547 | };
|
3548 | }
|