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: renderer excludes plain html from readme

See original GitHub issue

Description

on the pypa warehouse readme files which include plain HTML tags are not rendered correctly. The corresponding HTML section is just omitted. This was not the case a few weeks ago.

Expected Outcome

HTML tags of a readme are also rendered.

Actual Outcome

Plain HTML tags are omitted.

Example

The swarmlib project includes a plain paragraph <p></p> in its readme:

<p align="middle">
  <img src="https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/light_mode.png" width="49%" />
  <img src="https://raw.githubusercontent.com/HaaLeo/swarmlib/master/doc/dark_mode.png" width="49%" /> 
</p>

But for the latest release the images are not shown correctly on the pypi homepage. For swarmlib==0.12.1 the images are shown correctly. However, for swarmlib==0.13.0 no images are rendered in the readme. Since swarmlib did not change this section of its readme between the last releases I think the readme_renderer causes this issue.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:2
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

2reactions
dicommented, Nov 29, 2020

I made the necessary updates in https://github.com/pypa/readme_renderer/pull/181, will release that tomorrow.

1reaction
dicommented, Feb 21, 2021

Hmm, looks like I never did make that release, and this bit us again when I forgot about this bug and updated cmarkgfm again. I’ve (again) rolled back the cmarkgfm dependency in https://github.com/pypa/warehouse/pull/9123 and will try to revisit this again soon.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Rendering your README with GitHub Actions
After a lot of trial and error, this is how I got it working. The general use case I am imagining here is...
Read more >
Rendering your README with GitHub Actions - R-bloggers
After a lot of trial and error, this is how I got it working. The general use case I am imagining here is...
Read more >
Include my markdown README into Sphinx - Stack Overflow
The document object insists on having consistent header levels and the error message simply assumes the source was rst . If you are...
Read more >
README content | Bitbucket Cloud - Atlassian Support
Bitbucket can parse and display Markdown, reStructuredText, Textile, and plain text README files. With a syntax like Markdown, you can emphasize text, ...
Read more >
hexo-renderer-marked - npm
First solution is to enable option dompurify: true , which will sanitize the rendered HTML. The side effect of this solution is that...
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