Allow nested shortcodes

[ARitz-Cracker]

Fixes #515

Hello, and Happy Christmas 🎄

This PR iterates on #2630 with the given feedback of not requiring the use of the markdown filter to execute nested shortcodes. Additionally, unlike the previous PR, nested nth invocation increments follows a more intuitive pattern.

Before:

• 1
• 2
  • 5
  • 6
    • 9
    • 10
  • 7
  • 8
• 3
• 4

After:

• 1
• 2
  • 3
  • 4
    • 5
    • 6
  • 7
  • 8
• 9
• 10

Sanity check:

• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • This PR replaces Allow nested shortcodes with markdown bodies #2630

Code changes

• The shortcode parser has been changed to stop at the appropriate {% end %}, instead of the first-encountered {% end %}. (Thanks to Allow recursively nested shortcodes #1475)
• A clonable shared ShortcodeInvocationCounter has been added
• The markdown::shortcode::parser::Shortcode struct now has inner: Vec<Shortcode>
• The markdown::shortcode::parser::parse_for_shortcodes function now also parses shortcode bodies
• Added a flatten method to markdown::shortcode::parser::Shortcode which renders the inner-shortcodes into the shortcode body
• The render method on markdown::shortcode::parser::Shortcode now calls flatten

• Are you doing the PR on the next branch?

If the change is a new feature or adding to/changing an existing one:

• Have you created/updated the relevant documentation page(s)?
  • As far as I'm aware, the documentation does not explicitly prohibit nested short-codes.

Let me know what you think!

[ARitz-Cracker]

Oh, another thing, I noticed that when it comes to MD shortcodes calling HTML shortcodes, the HTML shortcode must be multi-line otherwise its result will get wrapped in a <p> tag. Where would be the appropriate place to document this?

[Keats]

Oh, another thing, I noticed that when it comes to MD shortcodes calling HTML shortcodes, the HTML shortcode must be multi-line otherwise its result will get wrapped in a

tag. Where would be the appropriate place to document this?

Not sure honestly. Sounds like a bug maybe?

[ARitz-Cracker]

Oh, another thing, I noticed that when it comes to MD shortcodes calling HTML shortcodes, the HTML shortcode must be multi-line otherwise its result will get wrapped in a tag. Where would be the appropriate place to document this?

Not sure honestly. Sounds like a bug maybe?

I... Actually don't think so, iirc if you have a single line with a <span> tag in an MD document, it being a part of a paragraph is expected behaviour, and after skimming through pulldown-cmark's source, it doesn't seem to have has inherent knowledge on whether or not an HTML element is an inline element (like a span) or a block element (like a div) resolving such issues seems outside the scope of this PR.

[ARitz-Cracker]

Applied the feedback given, lmk what you think!

[Keats]

Thanks!