[PR #607] [MERGED] Start of documentation on parser #1138

New Issue

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

claunia commented

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

📋 Pull Request Information

Original PR: https://github.com/xoofx/markdig/pull/607
Author: @mattj23
Created: 3/13/2022
Status: ✅ Merged
Merged: 4/10/2022
Merged by: @xoofx

Base: master ← Head: docs

📝 Commits (2)

d42b297 initial documentation on parser
25db6cb updated with initial comments

📊 Changes

3 files changed (+519 additions, -0 deletions)

View changed files

➕ doc/parsing-ast.md (+134 -0)
➕ doc/parsing-extensions.md (+158 -0)
➕ doc/parsing-overview.md (+227 -0)

📄 Description

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.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/xoofx/markdig/pull/607 **Author:** [@mattj23](https://github.com/mattj23) **Created:** 3/13/2022 **Status:** ✅ Merged **Merged:** 4/10/2022 **Merged by:** [@xoofx](https://github.com/xoofx) **Base:** `master` ← **Head:** `docs` --- ### 📝 Commits (2) - [`d42b297`](https://github.com/xoofx/markdig/commit/d42b2971281b2626eb147449fb355ddb24b80274) initial documentation on parser - [`25db6cb`](https://github.com/xoofx/markdig/commit/25db6cb4141649dc1b5b497f1e6d423d198e053b) updated with initial comments ### 📊 Changes **3 files changed** (+519 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `doc/parsing-ast.md` (+134 -0) ➕ `doc/parsing-extensions.md` (+158 -0) ➕ `doc/parsing-overview.md` (+227 -0) </details> ### 📄 Description 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

claunia added the pull-request label 2026-01-29 14:50:16 +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#1138