refactor(markdown): removed rehype-slug in favor of our own implementation
#3234
Conversation
🦋 Changeset detectedLatest commit: 73e1610 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
pkg: astro
JuanM04
changed the title
rehype-slug in favor of our own implementationrehype-slug in favor of our own implementation
|
|
||
| function rehypeCollectHeaders() { | ||
| return function (tree: any) { | ||
| const rehypeCollectHeaders: RehypePlugin<[]> = () => { |
There was a problem hiding this comment.
style nit: we usually avoid const X = () => {} in this code base, in favor of function X() {}.
Unless I'm missing something, you should be able to get the same type info like this:
function rehypeCollectHeaders(): RehypePlugin<[]> {
|
Feel free to merge if you can confirm that this PR didn't introduce this issue: withastro/docs#404 (comment) |
|
@FredKSchott ok, so I've added some notes about how it currently works (with or without this PR) in the documentation:
|
…ntation (withastro#3234) * Moved types arround * Removed `rehype-slug` in favor of our own implementation * Changeset * Removed rehype-slug from examples * Remove rehype-slug from tests * Updated reference * rehypeCollectHeaders is a function again * Reverted rehype-slug removes * Re-added rehype-slug to reference
Changes
While reviewing #3044, I've noticed that there is a function (
rehypeCollectHeaders) which is being used to generate slugs no matter what plugins the user specified. So, I've removedrehype-slugbecause it was doing the exact same thing (it even uses the same slugger!).Sidenote: I've moved some types around, so
headersare typed instead ofany[]Testing
It's already being tested
Docs
TDB