Skip to content

Add missing styles for Github's markdown alerts #796

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

Merged
merged 3 commits into from
Apr 21, 2025

Conversation

Steve-Tech
Copy link
Contributor

Hi, the styles for !TIP, !IMPORTANT, and !CAUTION markdown alerts seemed to be missing, but pdoc otherwise recognises them fine. This PR adds those styles and accompanying svg icons.

For example, the alerts look like this now:

Screenshot of markdown alerts in pdoc


For reference, here's Github's:

Note

Useful information that users should know, even when skimming content.

Tip

Helpful advice for doing things better or more easily.

Important

Key information users need to know to achieve their goal.

Warning

Urgent info that needs immediate user attention to avoid problems.

Caution

Advises about risks or negative outcomes of certain actions.


Thanks,
Steve

@mhils
Copy link
Member

mhils commented Apr 17, 2025

Thanks, this is great! Would you mind adding a CHANGELOG entry please?

@Steve-Tech
Copy link
Contributor Author

@mhils No worries! I've rebased and added a CHANGELOG entry.

Copy link
Member

@mhils mhils left a comment

Choose a reason for hiding this comment

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

Thanks! 🍰

@mhils mhils merged commit 59a2931 into mitmproxy:main Apr 21, 2025
14 checks passed
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.

2 participants