commonmark / commonmark/cmark

Expose reference links

Open
#64 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C
Stars
2k
Forks
691
Avg merge
1d 16h
Merged PRs (30d)
1

Description

It seems the parser automatically looks up references and turns them in to links. It would be nice to have a way to see the actual references and their definitions so we can use this library to programatically manipulate markdown documents without having all the references collapsed.

example:

> ./cmark --to commonmark <<EOF
[foo] [bar]

[bar]: /url "title"
EOF
[foo](/url "title")

Contributor guide

No contributing guide indexed for this repository

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 with the cmark parser and the reference-link handling exercised by the command-line example. Determine how references and their definitions can be exposed without collapsing them into links; done means programmatic users can inspect those definitions while the existing example output remains supported.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, markdown
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.