commonmark / commonmark/commonmark-java
Add more information to Link nodes (for round-trip rendering)
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 2.7k
- Forks
- 336
- PR merge metrics
- No merged PRs in 30d
Description
For #12, we need to preserve link reference definitions. We also need to be able to distinguish between the different link types (inline links, autolinks, reference links).
There is an old PR which might serve as a starting point: https://github.com/atlassian/commonmark-java/pull/20#issuecomment-142782665
I'm not sure yet what the final Node types should look like. Ideally we'd have an interface that all the links can implement for code that doesn't care about what the source representation was.
If someone is interested in working on this, please comment here first so we can figure out what the end result should look like.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading issue #12 and the old PR discussion at pull request #20, especially the comment linked in the issue. Clarify the final Node model and how inline links, autolinks, and reference links should be distinguished. Done means link reference definitions and source link types are preserved for round-trip rendering.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100