Fix READMEs fetched from GitHub #2
Merged
Conversation
This file contains 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
The previous technique for fetching GitHub READMEs was a bit broken because it relied on the repo’s default branch being `main`, which turned out not to always be the case. This commit uses the GitHub REST API to fetch the READMEs instead. This requires a GitHub Access Token to be added to the build environment variables as `PUBLIC_GITHUB_TOKEN`, but is a much more reliable way to get the content. Once I’d done that, I realised a bunch more rendering limitations with just plonking the raw Markdown from GitHub on a page: broken images & links and rendering anomalies. So I’ve built a remark pipeline to try to quickly emulate GitHub’s rendering and fix the images and links. It’s a bit like npm’s `marky-markdown`, but that doesn’t seem to be compatible with modern projects.
Agnostic UI linked to a package in the monorepo, so we need to handle that, not just top-level repo URLs
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
aFuzzyBear
approved these changes
May 21, 2022
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.
The previous technique for fetching GitHub READMEs was a bit broken because it relied on the repo’s default branch being
main, which turned out not to always be the case.This PR uses the GitHub REST API to fetch the READMEs instead. This requires a GitHub Access Token to be added to the build environment variables as
PUBLIC_GITHUB_TOKEN, but is a much more reliable way to get the content.Once I’d done that, I realised a bunch more rendering limitations with just plonking the raw Markdown from GitHub on a page: broken images & links and rendering anomalies. So I’ve built a remark pipeline to try to quickly emulate GitHub’s rendering and fix the images and links. It’s a bit like npm’s
marky-markdown, but that doesn’t seem to be compatible with modern projects.