TheShiveshNetwork / readmekraft

Craft Perfect GitHub Markdown Files with AI
https://readmekraft.vercel.app
GNU General Public License v2.0
21 stars 5 forks source link

[bug]: Markdown Rederer tool should be as close as that of Github #16

Open TheShiveshNetwork opened 2 weeks ago

TheShiveshNetwork commented 2 weeks ago

Description

The current issue with our markdown renderer is that it is not close to github. For example: Copy the code of Profile Readme and paste it on github. It will look entirely different.

This is how it looks on our markdown renderer: image

And this is how it looks on github: image

It can be seen that github is not retaining the stylings like grid. May be has some different styling for rendering these markdown files that we need to implement.

Files to be changed

Create a component for the Renderer and customize the content in the file: /components/RenderMarkdown.tsx Currently we are using react-markdown with the rehype plygin for rendering markdown this.

Possible Approach

Although I couldn't come across any perfect solution for this but one of the solutions could be to inspect the github markdown renderer and extract all the classes and styles. Also, I am not sure but there might be some markdown plugin for rendering it just like how github does.

For any possible discussions and suggestions, join this discord channel