proposal: extend admonition with tagline
Open
Nobody has claimed this yet.
C-enhancement
- Dominant language
- Rust
- Stars
- 22.2k
- Forks
- 1.9k
- PR merge metrics
- PR metrics pending
Description
Problem
Some people have custom HTML to create admonitions with extra taglines.
Came across this here:
https://github.com/kubernetes-sigs/kubebuilder/pull/5459
Proposed Solution
We can simply add text to the admonition block syntax:
> ![NOTE For fun]
>
> Head to the party!
Notes
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue provides the proposed admonition syntax but names no implementation files or tests. Start by locating mdBook's admonition parsing and rendering entry points, then compare the existing syntax with the example in the issue. Done means the tagline form is supported and covered by tests for the shown input.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100