UNPKG

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