Using markdown inside a paired shortcode

[chinchang]

I am using a nunjucks paired shortcode in a markdown file. The markdown within the paired shortcode is returned as it is in the shortcode function. Is it possible to get the compiled output of markdown?

[zachleat]

Yeah, I have run into this too and I don’t like it. 👍

[zachleat]

I ran a bunch of tests for this and most of them worked. There was one particular case of this that I did run into which felt unintuitive but was actually technically correct.

Specifically, this worked:

# Title
{% testShortcode %}## Paired title{% endtestShortcode %}

with

module.exports = function(eleventyConfig) {
	eleventyConfig.addPairedShortcode("testShortcode", function(content) {
		return '## Test' + "\n" + content;
	})
};

This worked too:

# Title
{% testShortcode %}

with

module.exports = function(eleventyConfig) {
	eleventyConfig.addShortcode("testShortcode", function() {
		return '## Test';
	})
}

However, this didn’t work:

	eleventyConfig.addPairedShortcode("callout", function(content, level = "warn") {
		return `<div class="elv-callout elv-callout-${level}">${content}</div>`;
	});

via https://github.com/11ty/11ty.io/blob/master/.eleventy.js#L58

Usage:

{% callout "info" %}The <code>addPassthroughCopy</code> method… {% endcallout %}

Any nested content in there had to be HTML and not Markdown because it was wrapped in HTML in the shortcode.

This wouldn’t work:

{% callout "info" %}The `addPassthroughCopy` method… {% endcallout %}

BECAUSE the output would be:

<div class="elv-callout elv-callout-warn">The `addPassthroughCopy` method… </div>

And baseline markdown can’t embed markdown inside of HTML like that.

[zachleat]

Does that make sense?

[zachleat]

So, to circle back to your original request and the research above, please follow along at enhancement request #148 to allow you to parse markdown inside of your shortcode function itself.

[zachleat]

This is an automated message to let you know that a helpful response was posted to your issue and for the health of the repository issue tracker the issue will be closed. This is to help alleviate issues hanging open waiting for a response from the original poster.

If the response works to solve your problem—great! But if you’re still having problems, do not let the issue’s closing deter you if you have additional questions! Post another comment and I will reopen the issue. Thanks!

[zachleat]

Added this to Common Pitfalls https://www.11ty.io/docs/languages/markdown/#why-can%E2%80%99t-i-return-markdown-from-paired-shortcodes-to-use-in-a-markdown-file

[zachleat]

Worth nothing that I added a workaround for this in my repo specifically https://github.com/11ty/11ty.io/blob/master/.eleventy.js#L59