commonmark / commonmark/commonmark.js

Same-document links

Open
#153 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
1.6k
Forks
231
Avg merge
2d 11h
Merged PRs (30d)
3

Description

Other markdown renderers support same-document links, like:

# This is my title

[Here](#this-is-my-title) is a link to the title section.

It would be nice if commonmark also supported this.

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 from the CommonMark JavaScript parser and renderer entry points and reproduce the heading-and-anchor example in the issue. Done means same-document links resolve from a heading such as “This is my title” to the corresponding section, with the existing renderer behavior otherwise preserved.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.