markdown-simple-ast v1.2.1

File size

6.14 kB

Installation

$ npm i -D markdown-simple-ast

Usage

  const md = require("markdown-simple-ast");
  md("# Markdown\nParagraph");
  // [{
  //    type: "h1",
  //    depth: 0,
  //    children: ["Markdown"]
  // }, {
  //    type: "p",
  //    depth: 0,
  //    children: ["Paragraph"]
  //  }
  // ]

Node types

Inline

Strong

**Strong**

  {
    type: "strong",
    children: ["Strong"]
  }

Emphasis (Italics)

*Emphasis*

  {
    type: "emphasis",
    children: ["Emphasis"]
  }

Strikethrough (del)

~~Strikethrough~~

  {
    type: "strikethrough",
    children: ["Strikethrough"]
  }

Image


  {
    type: "img",
    src: "http://www.cats.com/pictures/cat00001.jpg",
    alt: "A picture"
  }

Inline code

`var inline_code`

  {
    type: "inline-code",
    children: ["var inline_code"]
  }

Links

Link

[A link](http://www.google.com)

  {
    type: "a",
    href: "http://www.google.com",
    children: ["A link"]
  }

Reference style link

[Reference style link]1

  {
    type: "rlink",
    href: "1",
    children: ["A reference style link"]
  }

Reference

[arbitrary case-insensitive reference text]: https://www.mozilla.org

  {
    type: 'ref',
    depth: 0,
    href: 'https://www.mozilla.org',
    link: 'arbitrary case-insensitive reference text'
  }

Block

• depth is relative depth to the block parent

Block quote

> Block quote

  {
    type: "quote",
    depth: 0,
    children: [{
      type: "p",
      depth: 0,
      children: ["Block quote"]
    }]
  }

Horizontal rule

___ or *** or ---

  {
    type: "hr",
    depth: 0,
    children: []
  }

Paragraph text

Paragraph text

  {
    type: "p",
    depth: 0,
    children: ["Paragraph text"]
  }

Heading

# Heading

Maximum heading size is 6

  {
    type: "h1",
    depth: 0,
    children: ["Heading"]
  }

Unordered list

- List items

- List items

- List items

  {
    type: "ul",
    depth: 0,
    children: [{
      type: "li",
      children: ["List items"]
    }
    ...
    ]
  }

Ordered list

1. Ordered list items

2. Ordered list items

3. Ordered list items

  {
    type: "ol",
    depth: 0,
    children: [{
      type: "li",
      children: ["Ordered list items"]
    }
    ...
    ]
  }