Skip to content
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

Improve README content rendering and styles #5

Open
marcoroth opened this issue Aug 2, 2023 · 2 comments
Open

Improve README content rendering and styles #5

marcoroth opened this issue Aug 2, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@marcoroth
Copy link
Owner

For some gems on gem.sh the show page renders very weird and broken looking READMEs, we should look into what's causing it and see if there might be a more relaxed Markdown parser which can also better recover from a malformed markdown file.

It might also be that some of our styles are leaking into the rendered markdown content, maybe we need to better scope the selectors.

Example: https://gem.sh/gems/activerecord/v7.0.6

@marcoroth marcoroth added the bug Something isn't working label Aug 2, 2023
@ttilberg
Copy link
Contributor

ttilberg commented Aug 15, 2023

One such issue seems to be related to code blocks with a language specified. I was reviewing a simple gem I wrote and found the readme was looking in disarray.

For example, when the following codeblocks specifying ruby are encountered:

image

it renders as

image

and

image

Link to my example:

I believe the ActiveRecord example is currently suffering the same issue. Fixing the language detection for code blocks might go a long way to resolving the output.

@marcoroth
Copy link
Owner Author

marcoroth commented Aug 18, 2023

@ttilberg improved this a bit in #44, but I think there are still some thing we can improve, like:

Also some more advanced features could be cool:

  • the ability to copy code from code blocks and the
  • Auto-reference constants to the docs page when they are mentioned in the README

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants