60 60
class Math:
type = 'math'
enumerated : bool
enumerator : str
identifier : Any
label : Any
value : Any
position : Any
data : Any
class InlineMath:
type = 'inlineMath'
value : Any
position : Any
data : Any
class Abbreviation:
type = 'abbreviation'
children : List[StaticPhrasingContent]
title : str
position : Any
data : Any
class Directive:
Refs ? {'required'}
type = 'mystDirective'
name : str
args : str
?object
value : str
children : List[{'anyOf': [{'$ref': 'myst.schema.json#/$defs/FlowContent'}, {'$ref': 'myst.schema.json#/$defs/PhrasingContent'}]}]
position : Any
data : Any
class Comment:
type = 'mystComment'
value : Any
position : Any
data : Any
class Paragraph:
type = 'paragraph'
children : List[PhrasingContent]
position : Any
data : Any
class Heading:
Refs ? {'required'}
type = 'heading'
depth : int
enumerated : bool
enumerator : str
children : List[PhrasingContent]
identifier : Any
label : Any
position : Any
data : Any
class ThematicBreak:
type = 'thematicBreak'
position : Any
data : Any
class Blockquote:
type = 'blockquote'
children : List[FlowContent]
position : Any
data : Any
class List:
type = 'list'
ordered : bool
start : int
spread : bool
children : List[ListContent]
position : Any
data : Any
class ListItem:
type = 'listItem'
spread : bool
children : List[{'anyOf': [{'$ref': 'myst.schema.json#/$defs/PhrasingContent'}, {'$ref': 'myst.schema.json#/$defs/FlowContent'}]}]
position : Any
data : Any
class HTML:
type = 'html'
value : Any
position : Any
data : Any
class Code:
Refs ? {'if', 'then', 'else'}
Refs ? {'if', 'then', 'else'}
type = 'code'
lang : str
meta : str
class : str
showLineNumbers : bool
startingLineNumber : int
emphasizeLines : List[{'type': 'integer', 'minimum': 1}]
identifier : Any
label : Any
value : Any
position : Any
data : Any
class Definition:
type = 'definition'
identifier : Any
label : Any
url : Any
title : Any
position : Any
data : Any
class Text:
type = 'text'
value : Any
position : Any
data : Any
class Emphasis:
type = 'emphasis'
children : List[PhrasingContent]
position : Any
data : Any
class EmphasisStatic:
type = 'emphasis'
children : List[StaticPhrasingContent]
position : Any
data : Any
class Strong:
type = 'strong'
children : List[PhrasingContent]
position : Any
data : Any
class StrongStatic:
type = 'strong'
children : List[StaticPhrasingContent]
position : Any
data : Any
class InlineCode:
type = 'inlineCode'
value : Any
position : Any
data : Any
class Break:
type = 'break'
position : Any
data : Any
class Link:
type = 'link'
children : List[StaticPhrasingContent]
url : Any
title : Any
position : Any
data : Any
class Image:
type = 'image'
class : str
width : str
align : str
url : Any
title : Any
alt : Any
position : Any
data : Any
class LinkReference:
type = 'linkReference'
children : List[StaticPhrasingContent]
referenceType : Any
identifier : Any
label : Any
position : Any
data : Any
class ImageReference:
type = 'imageReference'
referenceType : Any
identifier : Any
label : Any
alt : Any
position : Any
data : Any
class Resource:
url : str
title : str
class OptionalAssociation:
identifier : str
label : str
class Association:
Refs ? {'required'}
identifier : Any
class Alternative:
alt : str
class Reference:
referenceType : str
class Target:
type = 'mystTarget'
label : str
position : Any
data : Any
class CrossReference:
type = 'crossReference'
kind : str
children : List[StaticPhrasingContent]
identifier : Any
label : Any
position : Any
data : Any
We likely have a union
FlowContent = Union[Paragraph,Definition,Heading,ThematicBreak,Blockquote,List,HTML,Code,Comment,Target,Directive,Admonition,Container,Math,Table,FootnoteDefinition]
We likely have a union
ListContent = Union[ListItem]
We likely have a union
PhrasingContent = Union[StaticPhrasingContent,Emphasis,Strong,Link,LinkReference,Subscript,Superscript,Underline,Abbreviation,CrossReference,FootnoteReference]
We likely have a union
StaticPhrasingContent = Union[Text,HTML,EmphasisStatic,StrongStatic,InlineCode,Break,Image,ImageReference,Role,SubscriptStatic,SuperscriptStatic,UnderlineStatic,InlineMath]
class Role:
Refs ? {'required'}
type = 'mystRole'
name : str
value : str
children : List[PhrasingContent]
position : Any
data : Any
class Admonition:
type = 'admonition'
kind : str
class : str
children : List[{'anyOf': [{'$ref': '#/$defs/AdmonitionTitle'}, {'$ref': 'myst.schema.json#/$defs/FlowContent'}]}]
position : Any
data : Any
class AdmonitionTitle:
type = 'admonitionTitle'
children : List[PhrasingContent]
position : Any
data : Any
class FootnoteReference:
type = 'footnoteReference'
identifier : Any
label : Any
position : Any
data : Any
class FootnoteDefinition:
type = 'footnoteDefinition'
children : List[FlowContent]
identifier : Any
label : Any
position : Any
data : Any
class Table:
type = 'table'
align : str
children : List[TableRow]
position : Any
data : Any
class TableRow:
type = 'tableRow'
children : List[TableCell]
position : Any
data : Any
class TableCell:
type = 'tableCell'
header : bool
align : str
children : List[PhrasingContent]
position : Any
data : Any
class BlockBreak:
type = 'blockBreak'
meta : str
position : Any
data : Any
class Block:
type = 'block'
meta : str
{'description': 'Top-level children of myst document', 'anyOf': [{'type': 'array', 'items': {'$ref': 'myst.schema.json#/$defs/FlowContent'}}, {'type': 'array', 'items': {'$ref': 'myst.schema.json#/$defs/ListContent'}}, {'type': 'array', 'items': {'$ref': 'myst.schema.json#/$defs/PhrasingContent'}}]}
children: TBD
position : Any
data : Any
class Subscript:
type = 'subscript'
children : List[PhrasingContent]
position : Any
data : Any
class SubscriptStatic:
type = 'subscript'
children : List[StaticPhrasingContent]
position : Any
data : Any
class Superscript:
type = 'superscript'
children : List[PhrasingContent]
position : Any
data : Any
class SuperscriptStatic:
type = 'superscript'
children : List[StaticPhrasingContent]
position : Any
data : Any
class Underline:
type = 'underline'
children : List[PhrasingContent]
position : Any
data : Any
class UnderlineStatic:
type = 'underline'
children : List[StaticPhrasingContent]
position : Any
data : Any
class Container:
Refs ? {'required'}
Refs ? {'if', 'then', 'else'}
type = 'container'
kind : str
class : str
enumerated : bool
enumerator : str
children : List[{'anyOf': [{'$ref': '#/$defs/Caption'}, {'$ref': '#/$defs/Legend'}, {'$ref': 'commonmark.schema.json#/$defs/Image'}, {'$ref': 'tables.schema.json#/$defs/Table'}]}]
identifier : Any
label : Any
position : Any
data : Any
class Caption:
type = 'caption'
children : List[FlowContent]
position : Any
data : Any
class Legend:
type = 'legend'
children : List[FlowContent]
position : Any
data : Any
class Node:
type : str
?object
!!!{'description': 'location of node in source file; must not be present for generated nodes', '$ref': '#/$defs/Position'}
class Literal:
Refs ? {'required'}
value : str
class Parent:
Refs ? {'required'}
children : List[Node]
class Point:
line : int
column : int
offset : int
class Position:
!!!{'description': 'place of first character of parsed source region', '$ref': '#/$defs/Point'}
!!!{'description': 'place of first character after parsed source region, whether it exists or not', '$ref': '#/$defs/Point'}
indent : List[{'type': 'integer', 'minimum': 0}]