Merged
Conversation
caugner
approved these changes
Nov 12, 2025
Comment on lines
+16
to
+17
| "turndown": "^7.2.2", | ||
| "turndown-plugin-gfm": "^1.0.2" |
Contributor
There was a problem hiding this comment.
What made you choose turndown?
Member
Author
There was a problem hiding this comment.
Honestly didn't put enormous thought into it: picked it when writing my prototype code, and didn't re-evaluate it when writing the proper code here as it worked fine. It's a mature lib, used widely, and has first party support for GFM.
Happy to consider alternatives though: but I'll merge for now because it'll be easy to swap out for a different library later.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Quite a lot here, but as before: commits are atomic, so should be easiest to review by stepping through the commits. Generally I'll have added a test in one commit and made it pass in the commit after.
Adds a tool to fetch documentation from MDN and render it to markdown. It uses Fred to first render the context to HTML, which requires a little bit of strange patching of things Fred expects, and then converts that to markdown. The advantage of this is it means we don't have to re-implement the render logic for some sections (like Specifications) now or in the future. I'm going to look at exposing a nicer interface for markdown rendering from Fred.