Examples that need to be markdown-it-async

[bao-cn]

I'm using markdown-it-async, but I can't configure it like markdown-it.

[olets]

Good to know. I'm not familiar with configuring markdown-it-async. Recommend opening an issue in its repo. antfu is likely aware of this plugin m, at least vaguely, because of the Shiki issue linked in the README and the Shiki docs PR linked in that issue's last comment.

[olets]

Closing because as I understand it this is a markdown-it-async question. But if you find a solution, please share it here. I'd be interested to learn, and it might help others.

[kevinramharak]

I ran into this issue for yoavbls/pretty-ts-errors#152.

I ended up using this, to monkey patch the original (default) fence rule and just strip out the outer tags:

function createMarkdownExitPatched(
  highlight: (code: string) => Promise<string>
) {
  const md = createMarkdownExit({
    html: true,
    highlight,
  });
  const fence = md.renderer.rules.fence;
  md.renderer.rules.fence = async (...args) => {
    let result = await fence!(...args);
    // annoyingly, markdown-[ex]it render code blocks with a wrapping `<pre><code>` block, and do not provide any means to prevent this
    // a custom fence rule is recommended, but requires having to copy (and maintain) internal utility functions, which is insanity if you ask me
    // see https://shiki.style/packages/markdown-it#transformer-caveats
    // and https://github.com/markdown-it/markdown-it/issues/269
    // and https://github.com/olets/markdown-it-wrapperless-fence-rule/issues/1
    // instead we use this replace to remove the annoying wrapper elements
    result = result.replace(/^<pre><code class="language-[a-zA-Z]+">/, "");
    result = result.replace(/<\/code><\/pre>\n?$/, "");
    return result.trim();
  };
  return md;
}

As for supporting markdown-exit, technically, the rule should check if highlight returns a promise and then return a promise as well. But since this code uses internal utilities from markdown-it, and markdown-exit does not expose those, I ended up going for my custom solution.