xoofx / xoofx/markdig

Add support for normalize - markdown document rountrip

Open
#155 33 comments 3 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

Followup of #17 and #32 and #154

This is an issue to track the remaining work to handle full markdown document round-trip

  • Support all CommonMark core components (#154)
    • Handle escape characters (by 6717be5)
    • Handle link reference definitions
  • Add normalize options (limit text width....etc.) - wip
    • Add options for basic elements (by de5ed119633b029d083c2e4a112722e4a03a84aa)
    • Add support for text width limit
  • Support all extensions (first focus on Github-GFM markdown, then the rest)
    • Abbreviations
    • AutoIdentifiers
    • AutoLinks
    • Bootstrap
    • Citations
    • CustomContainers
    • DefinitionLists
    • Diagrams
    • Emoji
    • EmphasisExtras
    • Figures
    • Footers
    • Footnotes
    • GenericAttributes
    • Hardlines
    • JiraLinks
    • ListExtras
    • Mathematics
    • MediaLinks
    • NonAsciiNoEscape
    • NoRefLinks
    • PragmaLines
    • SelfPipeline
    • SmartyPants
    • Table - Pipe (GFM)
    • Table - Grid
    • TaskLists (GFM)
    • Yaml

cc: @tthiery

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

Review issues #17, #32, and #154 alongside the remaining checklist, then choose a focused item such as the text-width limit or one GFM extension. Done means the selected round-trip behavior is supported and its checklist entry can be marked complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.