metalsmith / metalsmith/markdown
Prepare for marked 5.x
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 62
- Forks
- 65
- PR merge metrics
- No merged PRs in 30d
Description
Marked 5.x introduces a lot of almost breaking changes: it replaces most options with separate extension npm packages named `marked-*` (bummer). See: https://marked.js.org/using_advanced#extensions. Essentially this means `@metalsmith/markdown` must either:
1. switch away from marked as the default markdown renderer
2. include a lot of extra NPM packages by default just to keep feature parity.
3. not include any extra NPM packages and throw with an informative error.
Anyhow this will require a major release.
Contributor guide
No contributing guide indexed for this repository
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 with the linked Marked 5.x extensions documentation and compare its options and marked-* package changes with this plugin's current behavior. The issue names no files or tests; done requires choosing and implementing a compatibility path, documenting the resulting feature parity or informative error, and making the major release.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- web-dev
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100