Trying to create syntax extension and getting lost.

[oddevan]

Hey, all! Loving the library here, and I've been trying to dig in to it in order to build a Markdown dialect I've been working on (yes, I know, rationale in a bit). I'm trying to follow the logic in the Math extensions (per this previous question/answer), but I keep getting lost.

Has anyone written a tutorial or a high-level overview of what goes into a syntax feature in micromark/mdast? I feel like I'm missing some key context around how to tell the system where my syntax starts and stops. I'll admit I might be having a harder time since I'm trying to use a block quote-style delimiter (lines that start with ]), or it might just be that I'm coming from a PHP background instead of a JS background.

If there's a writeup that can help me see the bigger picture, I'd love a link. If there's nothing like that and I just need to keep studying the Math extensions, I can keep that up. I just want to know if there's another path I should be taking here.

Why I want to actually extend MD syntax despite multiple points against it

I'll admit I might need to just end up using annotations or hooking into tagged code blocks, but here's my thinking:

1. I very likely will be the only one using this. I'm hoping others will find it useful, but I'm building something for me.
2. I don't want my special sauce to look out-of-place in an otherwise normal Markdown document. Per the original:

   The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions.

3. I'm hoping to eventually mdast and combine it with something like mdast2docx so that I can turn the blocks I create in Markdown into specific structures in a Word doc.

Thanks for reading, and thanks for the amazing ecosystem!

[Murderlon]

Hi, I'm not aware of such write ups besides the introductory ones we have on https://unifiedjs.com/learn/ and the extending markdown section of micromark

Regarding custom syntax, since it's just for yourself and for fun, that's totally fair of course. Though you should probably at least consider remark-directive

[oddevan]

I appreciate the response regardless. Thanks!!