pdubroy / marked-ast

A modified version of chjj/marked that can produce an abstract syntax tree for Markdown

marked-ast

A modified version of marked that can produce an abstract syntax tree for Markdown.

Usage

var marked = require('marked-ast');
var ast = marked.parse('_This is **Markdown**_, he said.');
var html = marked.render(ast);

The package is just a wrapper for marked, so the produced HTML should be identical (if it isn't it's a bug). The AST produced in the example would look like this:

[
  {
    "type": "paragraph",
    "text": [
      {
        "type": "em",
        "text": [
          "This is ",
          {
            "type": "strong",
            "text": [ "Markdown" ]
          }
        ]
      },
      ", he said."
    ]
  }
]

Development

Basic setup:

git clone https://github.com/pdubroy/marked-ast.git
cd marked-ast
npm install
git submodule update --init

Running Tests

Use npm test to run the tests. Before checking code in, run npm run prepublish.

Updating Marked

To update to a new version of marked:

cd third_party/marked
git checkout <REF>  # E.g., `git checkout v0.3.3`
cd ../..
npm run rewrite && npm test

marked-ast's Issues

Link href with parens generates incorrect ast

Hey! Thanks for a great package!
The application I'm working on ran into this issue recently where if the href for a link contains non url encoded parens (()), the ast node generated for the link doesn't contain the full href.

marked-ast version: 0.3.0

Steps to reproduce:

1. Invoke MarkedAst._marked like so —

MarkedAst._marked('[Some link](https://something.xyz/(12)/1)', {
      // use renderer with altered methods for links and images
      renderer: new MarkedAst.AstBuilder(),
      // turn on Github-flavored MD goodies
      gfm: true,
      tables: true,
      breaks: true,
      smartypants: true,
      sanitize: false
    });

Expected ast:

[
  {
    "type": "paragraph",
    "text": [
      {
        "type": "link",
        "href": "https://something.xyz/(12)/1",
        "title": null,
        "text": [
          "Some link"
        ]
      }
    ]
  }
]

Received/Actual:

[
  {
    "type": "paragraph",
    "text": [
      {
        "type": "link",
        "href": "https://something.xyz/(12",
        "title": null,
        "text": [
          "Some link"
        ]
      },
      "/1)"
    ]
  }
]

Any ideas on how we can resolve this?
Thanks in advance!