question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

bug(www): some plugin READMEs are not properly rendered

See original GitHub issue

Description

Plugin description is not rendering the Readme file properly, instead only README.md is visible.

Steps to reproduce

Visit https://www.gatsbyjs.org/packages/gatsby-plugin-sass/

Expected result

image

Readme gatsby-plugin-sass should be transformed the same way as for other plugins

Actual result

What happened. image

Environment

Windows, checked in Chrome and Edge

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:25 (14 by maintainers)

github_iconTop GitHub Comments

1reaction
LekoArtscommented, Sep 30, 2020

My colleague added a commit to your PR removing the same entry from the other packages mentioned here 😃

1reaction
tesseraliscommented, Jul 8, 2020

I’m still seeing the invalid README pages on the described plugins so I don’t think this issue is resolved just yet. @viveksharmaui are you still interested in helping with this issue?

Read more comments on GitHub >

github_iconTop Results From Across the Web

[BUG] Code blocks are not properly rendered in the README ...
This is the code I add to the readme file: function hello() ... [BUG] Code blocks are not properly rendered in the README.md...
Read more >
Readme markdown not rendering in Xcode - Apple Developer
In Xcode 11.1, I created a 'README.md' markdown file, but it always renders as its raw text (yet font size changes depending on...
Read more >
README not rendered properly on the repository overview page ...
I noticed this, too. It does correctly render files called README.rst as reStructuredText, but not files called README. The documentation says "If the...
Read more >
How can I test what my readme.md file will look like before ...
I just found a very useful CLI tool for rendering GitHub flavored markdown: grip. It uses GitHub's API, thus renders quite well. Frankly,...
Read more >
Avid Maestro | News ReadMe v2019.12.7
Avid recommends that you read all the information in this ReadMe file thoroughly before installing or using any new software release.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found