metalsmith / metalsmith/excerpts
Simplify API by only providing multiple formats
- Dominant language
- JavaScript
- Stars
- 24
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Description
Would normalize the `excerpt` file property to always be `{ html: '...', text: '...' }`
Pro's:
* no need for a `multipleFormats` option (=simpler API)
* could add support for a third format: `stripped`, removing only the outer `
` tags
Cons:
* not backwards-compatible
* can't just put `{{ excerpt }}` in a template
Contributor guide
No contributing guide indexed for this repository
Research direction
No files, tests, or entry points are named. Start by locating the current excerpt property and multipleFormats option, then trace how templates consume excerpt values. Done means the proposed format and any third format are specified, compatibility implications are resolved, and coverage exists for the resulting API behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- tooling
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100