Brunobkr/llama.cpp_AlgMor24_github

1# ![MDAST](https://cdn.rawgit.com/wooorm/mdast/master/logo.svg)2 3> :warning:4>5> **mdast**, the pluggable markdown parser, was recently6> separated from this project and given a new name:7> **remark**.  See its documentation to read more about8> [what changed and how to migrate »](https://github.com/wooorm/remark/releases/tag/3.0.0)9 10**M**ark**d**own **A**bstract **S**yntax **T**ree format.11 12***13 14**MDAST** discloses markdown as an abstract syntax tree.  _Abstract_15means not all information is stored in this tree and an exact replica16of the original document cannot be re-created.  _Syntax Tree_ means syntax17**is** present in the tree, thus an exact syntactic document can be18re-created.19 20## AST21 22### Node23 24Node represents any unit in MDAST hierarchy.25 26```idl27interface Node {28    type: string;29    data: Data | null;30    position: Location?;31}32```33 34### Location35 36**Node** can have a reference to its original location, if applicable.37Start determines the line and column at which the original location starts;38end, respectively; and indent the column at which further lines start.39 40```idl41interface Location {42    start: Position;43    end: Position;44    indent: [uint32 >= 1]45}46```47 48### Position49 50A position contains a column and a line.  Both start at `1`.51 52```idl53interface Position {54    line: uint32 >= 1;55    column: uint32 >= 1;56}57```58 59### Data60 61Data represents data associated with any node.  Data is a scope for plug-ins62to store any information.  Its only limitation being that each property should63by `stringify`able: not throw when passed to `JSON.stringify()`.64 65```idl66interface Data { }67```68 69### Parent70 71Most nodes inherit the **Parent** ([**Node**](#node)) interface: nodes which72accept other nodes as children.73 74```idl75interface Parent <: Node {76    children: [Node];77}78```79 80### Text81 82Most others inherit **Text** ([**Node**](#node)): nodes which accept a value.83 84```idl85interface Text <: Node {86    value: string;87}88```89 90### Root91 92**Root** ([**Parent**](#parent)) houses all nodes.93 94```idl95interface Root <: Parent {96    type: "root";97}98```99 100### Paragraph101 102**Paragraph** ([**Parent**](#parent)) represents a unit of discourse dealing103with a particular point or idea.104 105```idl106interface Paragraph <: Parent {107    type: "paragraph";108}109```110 111### Blockquote112 113**Blockquote** ([**Parent**](#parent)) represents a quote.114 115```idl116interface Blockquote <: Parent {117    type: "blockquote";118}119```120 121### Heading122 123**Heading** ([**Parent**](#parent)), just like with HTML, with a level greater124than or equal to 1, lower than or equal to 6.125 126```idl127interface Heading <: Parent {128    type: "heading";129    depth: 1 <= uint32 <= 6;130}131```132 133### Code134 135**Code** ([**Text**](#text)) occurs at block level (see **InlineCode** for136code spans).  **Code** sports a language tag (when using GitHub Flavoured137Markdown fences with a flag, `null` otherwise).138 139```idl140interface Code <: Text {141    type: "code";142    lang: string | null;143}144```145 146### InlineCode147 148**InlineCode** ([**Text**](#text)) occurs inline (see **Code** for blocks).149Inline code does not sport a `lang` attribute.150 151```idl152interface InlineCode <: Text {153    type: "inlineCode";154}155```156 157### YAML158 159**YAML** ([**Text**](#text)) can occur at the start of a document, and160contains embedded YAML data.161 162```idl163interface YAML <: Text {164    type: "yaml";165}166```167 168### HTML169 170**HTML** ([**Text**](#text)) contains embedded HTML.171 172```idl173interface HTML <: Text {174    type: "html";175}176```177 178### List179 180**List** ([**Parent**](#parent)) contains **ListItem**’s.181 182The `start` property contains the starting number of the list when183`ordered: true`; `null` otherwise.184 185When all list items have `loose: false`, the list’s `loose` property is also186`false`.  Otherwise, `loose: true`.187 188```idl189interface List <: Parent {190    type: "list";191    loose: true | false;192    start: uint32 | null;193    ordered: true | false;194}195```196 197### ListItem198 199**ListItem** ([**Parent**](#parent)) is a child of a **List**.200 201Loose **ListItem**’s often contain more than one block-level elements.202 203When in `gfm: true` mode, a checked property exists on **ListItem**’s,204either set to `true` (when checked), `false` (when unchecked), or `null`205(when not containing a checkbox).  See206[Task Lists on GitHub](https://help.github.com/articles/writing-on-github/#task-lists)207for information.208 209```idl210interface ListItem <: Parent {211    type: "listItem";212    loose: true | false;213    checked: true | false | null | undefined;214}215```216 217### Table218 219**Table** ([**Parent**](#parent)) represents tabular data, with alignment.220Its children are either **TableHeader** (the first child), or **TableRow**221(all other children).222 223`table.align` represents the alignment of columns.224 225```idl226interface Table <: Parent {227    type: "table";228    align: [alignType];229}230```231 232```idl233enum alignType {234    "left" | "right" | "center" | null;235}236```237 238### TableHeader239 240**TableHeader** ([**Parent**](#parent)).  Its children are always **TableCell**.241 242```idl243interface TableHeader <: Parent {244    type: "tableHeader";245}246```247 248### TableRow249 250**TableRow** ([**Parent**](#parent)).  Its children are always **TableCell**.251 252```idl253interface TableRow <: Parent {254    type: "tableRow";255}256```257 258### TableCell259 260**TableCell** ([**Parent**](#parent)).  Contains a single tabular field.261 262```idl263interface TableCell <: Parent {264    type: "tableCell";265}266```267 268### HorizontalRule269 270Just a **HorizontalRule** ([**Node**](#node)).271 272```idl273interface HorizontalRule <: Node {274    type: "horizontalRule";275}276```277 278### Break279 280**Break** ([**Node**](#node)) represents an explicit line break.281 282```idl283interface Break <: Node {284    type: "break";285}286```287 288### Emphasis289 290**Emphasis** ([**Parent**](#parent)) represents slightly important text.291 292```idl293interface Emphasis <: Parent {294    type: "emphasis";295}296```297 298### Strong299 300**Strong** ([**Parent**](#parent)) represents super important text.301 302```idl303interface Strong <: Parent {304    type: "strong";305}306```307 308### Delete309 310**Delete** ([**Parent**](#parent)) represents text ready for removal.311 312```idl313interface Delete <: Parent {314    type: "delete";315}316```317 318### Link319 320**Link** ([**Parent**](#parent)) represents the humble hyperlink.321 322```idl323interface Link <: Parent {324    type: "link";325    title: string | null;326    href: string;327}328```329 330### Image331 332**Image** ([**Node**](#node)) represents the figurative figure.333 334```idl335interface Image <: Node {336    type: "image";337    title: string | null;338    alt: string | null;339    src: string;340}341```342 343### Footnote344 345**Footnote** ([**Parent**](#parent)) represents an inline marker, whose346content relates to the document but is outside its flow.347 348```idl349interface Footnote <: Parent {350    type: "footnote";351}352```353 354### LinkReference355 356**Link** ([**Parent**](#parent)) represents a humble hyperlink, its `href`357and `title` defined somewhere else in the document by a **Definition**.358 359```idl360interface LinkReference <: Parent {361    type: "linkReference";362    identifier: string;363}364```365 366### ImageReference367 368**Link** ([**Node**](#node)) represents a figurative figure, its `src` and369`title` defined somewhere else in the document by a **Definition**.370 371```idl372interface ImageReference <: Node {373    type: "imageReference";374    alt: string | null;375    identifier: string;376}377```378 379### FootnoteReference380 381**FootnoteReference** ([**Node**](#node)) is like **Footnote**, but its382content is already outside the documents flow: placed in a383**FootnoteDefinition**.384 385```idl386interface FootnoteReference <: Node {387    type: "footnoteReference";388    identifier: string;389}390```391 392### Definition393 394**Definition** ([**Node**](#node)) represents the definition (i.e., location395and title) of a **LinkReference** or an **ImageReference**.396 397```idl398interface Definition <: Node {399    type: "definition";400    identifier: string;401    title: string | null;402    link: string;403}404```405 406### FootnoteDefinition407 408**FootnoteDefinition** ([**Parent**](#parent)) represents the definition409(i.e., content) of a **FootnoteReference**.410 411```idl412interface FootnoteDefinition <: Parent {413    type: "footnoteDefinition";414    identifier: string;415}416```417 418### TextNode419 420**TextNode** ([**Text**](#text)) represents everything that is just text.421Note that its `type` property is `text`, but it is different from **Text**.422 423```idl424interface TextNode <: Text {425    type: "text";426}427```428 429## Related430 431*   [remark](https://github.com/wooorm/remark)432*   [unist](https://github.com/wooorm/unist)433*   [nlcst](https://github.com/wooorm/nlcst)434*   [vfile](https://github.com/wooorm/vfile)435 436### License437 438MIT © [Titus Wormer](http://wooorm.com)439