[PR #607] Start of documentation on parser #1143

New Issue

claunia · 2026-01-29T14:50:19Z

claunia commented

2026-01-29 14:50:19 +00:00

Original Pull Request: https://github.com/xoofx/markdig/pull/607

State: closed
Merged: Yes

In reference to #597, here's an initial attempt at starting some prosaic documentation on the workings of the Markdig parser. I could use some hints as to how the internal guts of the BlockParser and InlineParser work in order to figure them out enough to document them. The rest I feel a little more confident in, but that doesn't mean there aren't some glaring mistakes or misunderstandings I made why trying to understand the library from the code.

@xoofx, I'm not sure exactly what your vision was for the overall documentation structure, so I wrote this with the understanding that it would probably be re-structured and re-partitioned into some other organization. For that reason I tried to keep sections small and atomic enough that they'd still be useful if they have to be shuffled around.

I'll keep working on this, but I'm probably at a point where I could start to benefit from some feedback. However you want to do the review/edit cycle is good with me.

Thanks again for this library.

**Original Pull Request:** https://github.com/xoofx/markdig/pull/607 **State:** closed **Merged:** Yes --- In reference to #597, here's an initial attempt at starting some prosaic documentation on the workings of the Markdig parser. I could use some hints as to how the internal guts of the `BlockParser` and `InlineParser` work in order to figure them out enough to document them. The rest I feel a little more confident in, but that doesn't mean there aren't some glaring mistakes or misunderstandings I made why trying to understand the library from the code. @xoofx, I'm not sure exactly what your vision was for the overall documentation structure, so I wrote this with the understanding that it would probably be re-structured and re-partitioned into some other organization. For that reason I tried to keep sections small and atomic enough that they'd still be useful if they have to be shuffled around. I'll keep working on this, but I'm probably at a point where I could start to benefit from some feedback. However you want to do the review/edit cycle is good with me. Thanks again for this library.

claunia added the pull-request label 2026-01-29 14:50:19 +00:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/markdig#1143