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(shortcodes): add admonition shortcode #285

Merged
merged 1 commit into from
Mar 20, 2024
Merged

Conversation

welpo
Copy link
Owner

@welpo welpo commented Mar 20, 2024

Summary

Adds "admonition" shortcode, inspired by Docusaurus.

Using them is as simple as:

{{ admonition(type="note", title="Custom title", text="Some **content** with _Markdown_ `syntax`. Check [this `api`](#).") }}

Docs available in the shortcodes page.

Screenshots

admonitions

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 Mar 20, 2024
@welpo welpo merged commit 071ca28 into main Mar 20, 2024
5 checks passed
@welpo welpo deleted the feat/admonitions branch March 20, 2024 16:50
@welpo welpo changed the title ✨ feat(shortcodes): add admonition shortcodes ✨ feat(shortcodes): add admonition shortcode Mar 20, 2024
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.

1 participant