Jetpack: Markdown block: Parsing issues and inconsistencies

Created on 12 Oct 2018  路  6Comments  路  Source: Automattic/jetpack

In testing how elements are recognized and parsed in our Jetpack Markdown block for Gutenberg, we've discovered several issues and inconsistencies so far.

This is a master issue for all of them, feel free to add any others that you find.

  • [ ] Footnotes / reference links differences
  • [ ] Images with alts and titles not supported

    • Reported by @jeherve in p1HpG7-5EW-p2 #comment-27928

  • [ ] Single empty lines are omitted

    • Reported by @Stojdza in p1HpG7-5EW-p2 #comment-27911

    • Reported by @carladoria in p58i-7sR-p2 #comment-40539

    • Reported by @reginabally in p58i-7sR-p2 #comment-40610

  • [ ] Alternative heading syntax parsed incorrectly on iPad Pro

    • Reported by @eliorivero in p1HpG7-5EW-p2 #comment-27968

  • [ ] Code block not properly styled

    • Reported by @carladoria in p58i-7sR-p2 #comment-40539

Good For Community Gutenberg Markdown Primary Issue [Pri] Low [Type] Bug

Most helpful comment

I was asked in https://wordpress.org/support/topic/definition-lists-not-working-in-markdown-gutenberg-block/#post-11127209 to add some notes here.

Also missing from the above list are definition lists and abbreviations. These are both part of Markdown Extra, which is what the Jetpack Markdown module is documented to use. WP.com also claims support for these features on its Markdown support page

There are markdown-it plugins available for the missing features:

All 6 comments

FWIW, some of those are already fixable:

  • Empty lines omitted - fixable if we make breaks: true for the parser.
  • Footnotes / reference links - there's a plugin for adding support

Anyway, fixing them is not so straightforward, because we'd also need to account for them in our WP.com implementation of Markdown.

I was asked in https://wordpress.org/support/topic/definition-lists-not-working-in-markdown-gutenberg-block/#post-11127209 to add some notes here.

Also missing from the above list are definition lists and abbreviations. These are both part of Markdown Extra, which is what the Jetpack Markdown module is documented to use. WP.com also claims support for these features on its Markdown support page

There are markdown-it plugins available for the missing features:

Guys, what is not being said here? 2+ years for NOT resolving something so important to many users. There must be a story behind this.

@DBJDBJ We're not currently working on the Markdown block, but when we do come back and iterate on that block, we'll definitely be tackling some of the items on the list above.

Until then, we've marked this issue as "Good For Community". That means that we'll be happy to review any improvements and bug fixes suggested by community members like you.

@jeherve What is good for me I have now done: uninstalled Jet Pack. Actually I would very much like to move to HUGO but dbj.org is 500+ posts. It will be done.

Was this page helpful?
0 / 5 - 0 ratings