[Docs Site] Decode HTML entities and strip Markdown from page descriptions #19350
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
KianNH
requested review from
a team,
GregBrimble,
ToriLindsay,
WalshyDev,
haleycode,
irvinebroque,
kodster28,
kristianfreeman,
marciocloudflare,
maxvp,
mikenomitch and
pedrosousa
as code owners
KianNH
commented
Jan 22, 2025
| } | ||
| Astro.props.entry.data.description ??= await getPageDescription( | ||
| Astro.props.entry.data.description = await getPageDescription( |
Member
Author
There was a problem hiding this comment.
We used to do if (entry.data.description) return entry.data.description; in getPageDescription but that didn't do anything - because we never used this function if that property existed.
That was a bug, but also fine since we never would have changed it. Now we are transforming it so removed ??.
Comment on lines
+4
to
+5
| import { remark } from "remark"; | ||
| import strip from "strip-markdown"; |
Member
Author
There was a problem hiding this comment.
This could technically be done in a lot more lines with marked but most of their discussions recommend using other libraries, like strip-markdown.
| const paragraph = dom.querySelector(":root > p"); | ||
|
|
||
| if (description) return description.innerText; | ||
| if (paragraph) description = he.decode(paragraph.innerText); |
| let description = undefined; | ||
|
|
||
| if (entry.data.description) { | ||
| const file = await remark().use(strip).process(entry.data.description); |
Member
Author
There was a problem hiding this comment.
[`workers-rs` crate](https://github.com/cloudflare/workers-rs)` -> `workers-rs crate`
github-actions
bot
assigned
dcpena,
haleycode,
patriciasantaana,
pedrosousa,
GregBrimble,
kodster28,
kristianfreeman,
marciocloudflare,
maxvp and
WalshyDev
Deploying cloudflare-docs with
|
| Latest commit: |
03be761
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f2c45653.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://kian-pcx-14260.cloudflare-docs-7ou.pages.dev |
Contributor
|
Files with changes (up to 15)
|
kodster28
approved these changes
Jan 22, 2025
Collaborator
kodster28
left a comment
kodster28
left a comment
There was a problem hiding this comment.
Output lgtm + this should only affect descriptions so it's a low-risk change.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
11 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Before:
After: