xoofx / xoofx/markdig

Inline figures

Open
#602 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Hello,

I've just been looking at ways of including figures in my markdown document, I notice you have Figure support with fenced code but I am working on a project where my user base are teachers and non-tech people, I think fenced could be too daunting for them, although it does offer more flexibility.
I would like to suggest inline <figure> and <figcaption> as per markdown-it-image-figures.

What do you think?

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

Read src/Markdig.Tests/Specs/FigureFooterAndCiteSpecs.md to understand the existing fenced figure support, then compare the proposed behavior with markdown-it-image-figures. Define the expected inline figure and figcaption syntax and add coverage showing that it works for the intended teacher-friendly usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, markdown
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.