Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Rename or remove addMarkdownHighlighter #3105

Open
Snapstromegon opened this issue Nov 14, 2023 · 0 comments
Open

Rename or remove addMarkdownHighlighter #3105

Snapstromegon opened this issue Nov 14, 2023 · 0 comments
Labels
breaking-change This will have to be included with a major version as it breaks backwards compatibility. enhancement feature: 🥸 API consistency good first issue

Comments

@Snapstromegon
Copy link
Member

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 the set*() 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

@Snapstromegon Snapstromegon added good first issue breaking-change This will have to be included with a major version as it breaks backwards compatibility. feature: 🥸 API consistency labels Dec 3, 2023
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
breaking-change This will have to be included with a major version as it breaks backwards compatibility. enhancement feature: 🥸 API consistency good first issue
Projects
None yet
Development

No branches or pull requests

1 participant