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

Update README logos for better compatibility #2603

Merged
merged 2 commits into from
Jun 2, 2024

Conversation

ewels
Copy link
Member

@ewels ewels commented May 31, 2024

Note

PR created without any manual intervention - entirely AI driven and created, using GitHub Copilot Workspace. The only thing I did by hand was write this note! (@ewels)


Related to #2567

Updates the README.md to use the <picture> HTML tag for displaying the MultiQC logo, ensuring compatibility with both light and dark modes on PyPI and other platforms.

  • Replaces the GitHub-specific markdown for light and dark mode logos with a <picture> element that includes <source> elements for both modes. This ensures the correct logo is displayed based on the user's preference.
  • Adds a default <img> tag within the <picture> element to provide a fallback logo for environments where <picture> is not supported.

For more details, open the Copilot Workspace session.

Copy link
Member Author

@ewels ewels left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the markdown parsing is messing this up. Switching to a <h1> tag which is the same syntax as the nf-core/tools README.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@ewels ewels linked an issue May 31, 2024 that may be closed by this pull request
@vladsavelyev vladsavelyev self-requested a review June 2, 2024 16:08
@vladsavelyev vladsavelyev merged commit 11c58fa into main Jun 2, 2024
2 checks passed
@vladsavelyev vladsavelyev deleted the ewels/update-readme-logos branch June 2, 2024 16:10
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.

Fix PyPI readme logo
2 participants