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

✨ feat(admonitions): allow swapping admonition icons #340

Merged
merged 1 commit into from
Jun 27, 2024

Conversation

welpo
Copy link
Owner

@welpo welpo commented Jun 27, 2024

Summary

This PR adds the ability to customise icons for admonitions.

Related issue

Resolves #337.

Changes

  • Updated admonition shortcode to accept a custom icon parameter
  • Modified CSS to support custom icons while maintaining existing styles
  • Added documentation for the new icon customization feature

Accessibility

The changes maintain the existing accessibility features of admonitions.

Screenshots

ss

Type of change

  • Bug fix (fixes an issue without altering functionality)
  • New feature (adds non-breaking functionality)
  • Breaking change (alters existing functionality)
  • UI/UX improvement (enhances user interface without altering functionality)
  • Refactor (improves code quality without altering functionality)
  • Documentation update
  • Other (please describe below)

Checklist

  • I have verified the accessibility of my changes
  • I have tested all possible scenarios for this change
  • I have updated theme.toml with a sane default for the feature
  • I have made corresponding changes to the documentation:
    • Updated config.toml comments
    • Updated theme.toml comments
    • Updated "Mastering tabi" post in English
    • (Optional) Updated "Mastering tabi" post in Spanish
    • (Optional) Updated "Mastering tabi" post in Catalan

@welpo welpo added the enhancement New feature or request label Jun 27, 2024
Copy link

netlify bot commented Jun 27, 2024

Deploy Preview for tabi-demo ready!

Name Link
🔨 Latest commit 53d520d
🔍 Latest deploy log https://app.netlify.com/sites/tabi-demo/deploys/667db819eaa4510008d3196a
😎 Deploy Preview https://deploy-preview-340--tabi-demo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@welpo welpo force-pushed the feat/custom-admonition-icons branch from d13e16c to 53d520d Compare June 27, 2024 19:05
@welpo welpo merged commit d689c15 into main Jun 27, 2024
7 checks passed
@welpo welpo deleted the feat/custom-admonition-icons branch June 27, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Icons for "info" and "note" admonitions should be the other way around
1 participant