xoofx / xoofx/markdig

Guidance for implementing a SkiaSharp renderer

Open
#804 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

Hi!

I'm interested in implementing a custom renderer for Markdig to render to SkiaSharp. SkiaSharp provides a "Canvas" element with methods like DrawLine, DrawImage, DrawText etc. That would make it possible to render to PNGs, PDFs...

Could somebody give me a starting point? I got a bit confused by the Normalize-Render classes, ObjectRenderers.. What would be the easiest point to start an implementation? Also, what would be the best thing to make the implementation as complete as possible (i.e. no missing renderers for components)?

Thank you very much!

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 reading Markdig's Normalize-Render classes and ObjectRenderers, which the issue identifies as confusing entry points. The work would be complete when a SkiaSharp renderer supports the Markdown components without missing renderers and can render to PNG or PDF.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
computer-graphics
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.