spec: Markdown inside HTML blocks

[MurakamiShinyu]

How to enable markdown inside HTML blocks? There are differences between major Markdown dialects:

• Pandoc Markdown: markdown is enabled by default inside HTML blocks
  • See: Pandoc Extension: markdown_in_html_blocks
• GFM and CommonMark: markdown is enabled if there is a blank line after the start tag
  • See: GFM Spec: HTML blocks
• PHP Markdown Extra: markdown is enabled if markdown="1" is added in the start tag
  • See: PHP Markdown Extra: Markdown Inside HTML Blocks

I think Pandoc Markdown's method is most useful and easy to understand.

Examples:

<div class="foo">
* Here, markdown is **enabled** in Pandoc Markdown
</div>

<div class="foo">

* Here, markdown is **enabled** in GFM and CommonMark
</div>

<div class="foo" markdown="1">
* Here, markdown is **enabled** in PHP Markdown Extra
</div>

[uetchy]

Consecutive HTML blocks should be treated as plain HTML. Parsing content inside HTML and handling them as Markdown could produce an unwanted effect.

For styled divs with Markdown, there's already Fenced blocks #5.

[MurakamiShinyu]

Consecutive HTML blocks should be treated as plain HTML.

Ok, it will be compatible with GFM and CommonMark, and also default behavior of the remark parser.

[akabekobeko]

本件はドキュメントに VFM が CommonMark/GFM のスーパーセットであることを記述することを持って close 予定。

[akabekobeko]

すでに docs/vfm.md で

VFM is implemented top on CommonMark and GFM.

と言及されているので close します。結論としては途中のコメントにもありますが現状は GFM 準拠ということになります。

もし GFM と異なる記法 (機能) で対応を希望される場合は、その旨をコメントのうえ Reopen してください。