Markbind: Document multiple markdown-it-attrs for users

[Tejas2805]

Tell us about your environment

MacOS

• MarkBind Version:
  Latest master

What did you do? Please include the actual source code causing the issue.

html ```xml {heading="Heading title", highlight-lines="2"} <foo> <bar type="name">goo</bar> </foo> ```

What did you expect to happen?

The , shouldn't have appeared in the heading title.

What actually happened? Please include the actual, raw output.

Can check PR #1105

[damithc]

The , shouldn't have appeared in the heading title.

Should there be a comma in the code in the first place?
I was trying this feature earlier, and in the absence of documentation,
I ended up using {heading="x" highlight-lines="2"} which seems to work.

@openorclose @nbriannl what's the correct syntax to use? comma or just space?

[nbriannl]

Just a space. I see that there's an issue raised regarding documentation, I commented on the correct syntax.

[nbriannl]

Having that said, this is not a bug. The syntax for multiple code-block features does not include a comma, just a space.

[ang-zeyu]

Same goes for other markdown using markdown-it-attrs as well
https://www.npmjs.com/package/markdown-it-attrs
Supported syntax: {.class #identifier attr=value attr2="spaced value"}

Perhaps a documentation update regarding markbind's use of markdown-it-attrs is due though, since its used for many other things besides code blocks

[nbriannl]

Are there other markbind features where multiple markdown-it-attrs are used, other than code blocks?

[Tejas2805]

Maybe this can be added to tips and tricks?

[ang-zeyu]

Are there other markbind features where multiple markdown-it-attrs are used, other than code blocks?

Any markdown can use it ( paragraphs, lists, code blocks, inline markdown, etc. ), its sort of an unmentioned feature.

Maybe this can be added to tips and tricks?

Perhaps a sub-section under formatting contents would be better, since its a feature with quite a few use cases we don't want the user to miss.

[Tejas2805]

Changing issue name accordingly.

[ang-zeyu]

@Tejas2805 are you working on this?

I've raised it to medium priority as use of markdown-it-attrs is rather obscure compared to nunjucks, and can cause apparent bugs to the user that is actually expected behaviour ( see #1196 )

[Tejas2805]

Sure. Will have a PR up shortly.