jonathantneal/posthtml-md

How to pass options to marked.js?

hvab opened this issue · 3 comments

hvab commented

From gulp example:

...
posthtml([
  require('posthtml-md')({ /* options */ })
])
...

If I pass options, it nothing happened. For example I need code highlight and remove id:

...
posthtml([
  require('posthtml-md')({
        headerIds: false,
        highlight: function(code) {
          return require('highlight.js').highlightAuto(code).value;
        },
      })
])
...

And result without changes.

Vbitz commented

I'm using Parcel and I was able to put

var myMarked = require('marked');

myMarked.setOptions({
    renderer: new myMarked.Renderer(),
    highlight: function(code) {
        return require('highlight.js').highlightAuto(code).value;
    },
    pedantic: false,
    gfm: true,
    tables: true,
    breaks: false,
    sanitize: false,
    smartLists: true,
    smartypants: false,
    xhtml: false
});

before I declared required posthtml-md to set global options.

cossssmin commented

The options passed here:

posthtml-md/index.js

Line 106 in a6f8150

return parser.use(module.exports(options)).process(contents);

... are not accepted in the default export:

posthtml-md/index.js

Line 99 in a6f8150

module.exports = function () {

... and then marked doesn't use any, either:

posthtml-md/index.js

Line 45 in a6f8150

node = marked(node).trim();

Now, if you don't have marked as a dependency in your own project, you won't be able to require it like @Vbitz mentioned; instead, you'd need to do something like require('posthtml-md/node_modules/marked')

Even so, the plugin doesn't work as expected: headerIds does nothing, for example.

Also, using GFM fenced code blocks with info strings produces unexpected results:

Input:

```html
<div>some text</div>
```

Output:

<p><code>`</code>html</p>
<div><p>some text</p></div>

Even not specifying the info string, but using HTML inside the fenced code block:

```
<div>some text</div>
```

... produces:

<p><code>`</code></p>
<div><p>some text</p></div>
  • 👍1
OzymandiasTheGreat commented

So I submitted a pull request to actually pass options to marked, but after checking out the code
I can say this plugin will break again and again and maintenance will be a pain in the behind.

I put together a simpler code-wise alternative yesterday, but I did it in a single afternoon and didn't do much more than basic testing so it may be buggy. Still it fixes all the issues mentioned in this thread, so you may want to check it out. I just published it to npm.

  • 👍1