playframework / playframework/play-doc
Replace pegdown with a maintained library
Open
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 23
- Forks
- 21
- Avg merge
- 1d 20m
- Merged PRs (30d)
- 14
Description
Pegdown is not being maintained anymore and has reached EOL:
https://github.com/sirthias/pegdown/#-deprecation-note-
The suggested alternative is flexmark-java which has a documented migration path.
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
Review the existing pegdown integration in the documentation rendering support and consult the flexmark-java migration helper linked in the issue. Done means pegdown is replaced with flexmark-java while the documented rendering behavior remains supported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, scala
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100