-
-
Notifications
You must be signed in to change notification settings - Fork 577
Rename or remove addMarkdownHighlighter #3105
Copy link
Copy link
Closed
Labels
breaking-changeThis will have to be included with a major version as it breaks backwards compatibility.This will have to be included with a major version as it breaks backwards compatibility.converted-to-discussionenhancementfeature: 🥸 API consistencyon-hold
Metadata
Metadata
Assignees
Labels
breaking-changeThis will have to be included with a major version as it breaks backwards compatibility.This will have to be included with a major version as it breaks backwards compatibility.converted-to-discussionenhancementfeature: 🥸 API consistencyon-hold
Is your feature request related to a problem? Please describe.
In general the
add*()functions of the eleventy config are non-destructive if possible.addMarkdownHightlighter()on the other hand behaves like theset*()functions.Also this function IMO is no longer necessary, since there are other, better and better documented options in eleventy.
Function in code:
https://github.com/11ty/eleventy/blob/main/src/UserConfig.js#L170
Describe the solution you'd like
I would recommend to either remove this function completely with the next major version, or to rename it to
setMarkdownHighlighter()and add documentation for it.Describe alternatives you've considered
Not changing anything is possible, but leaves this in a weird state.
Additional context
No response