Skip to content

Feature: Added tab to display README from GitHub repo #12

New issue

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

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

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

epoll31
Copy link
Contributor

@epoll31 epoll31 commented Apr 30, 2024

I added a tab that loads the readme.md file from GitHub through the Octokit API (lib/actiona/get-readme.ts).

I pass load that into a component name Readme in components/projects/project-readme.tsx that uses the react-markdown package. I imported the same plugins using #3 as a reference

  • rehype-autolink-headings
  • rehype-pretty-code
  • rehype-raw
  • rehype-slug
  • remark-gfm

For the code block syntax highlighting I used Shiki v1.3.0 with the 'github-light' theme. I do the actual syntax highlighting in a server action (lib/actions/code-to-html.ts) instead of as a plugin to react-markdown which makes it very easy to use and customize.

For the markdown components, I implemented most of them directly in components/projects/project-readme.tsx to keep the imports minimal since most of them are simple. However, I did implement Code in components/md/Code.tsx since it is a bit more complex and requires hooks to perform a call the codeToHtml server action.

I checked my markdown implementation using a complete markdown example.

I kept the styling very minimal, but feel free to let me know how you would like them to look and I can add to the styles.

Here are screenshots of the results of that so that you can see what it looked like.
Screenshot 2024-04-29 at 8 12 04 PM
Screenshot 2024-04-29 at 8 12 16 PM
Screenshot 2024-04-29 at 8 12 27 PM
Screenshot 2024-04-29 at 8 12 41 PM
Screenshot 2024-04-29 at 8 12 50 PM
Screenshot 2024-04-29 at 8 13 01 PM
Screenshot 2024-04-29 at 8 13 13 PM
Screenshot 2024-04-29 at 8 13 24 PM
Screenshot 2024-04-29 at 8 13 40 PM
Screenshot 2024-04-29 at 8 13 50 PM

Copy link

vercel bot commented Apr 30, 2024

@epoll31 is attempting to deploy a commit to the Dub Team on Vercel.

A member of the Team first needs to authorize it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant