xoofx / xoofx/markdig

Alerts are not recognized when they include a title

Open
#809 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
C#
Stars
5.3k
Forks
510
Avg merge
8d 5h
Merged PRs (30d)
5

Description

Obsidian allows adding titles to alerts/callouts. When Markdig parses an alert with a title, it is recognized as a QuoteBlock instead of an AlertBlock. It would be nice if Markdig could support the optional title.

> [!NOTE] Custom Title
> Lorem Ipsum

The behavior is consistent with the way GitHub displays alerts with titles though:

[!NOTE] Custom Title
Lorem Ipsum

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the Markdown example with Markdig and trace why an alert with an optional title becomes a QuoteBlock rather than an AlertBlock. Identify the alert parsing entry point and relevant tests, then confirm that titled alerts produce an AlertBlock while untitled alerts retain their existing behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, markdown
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.