✨ feat(shortcodes): add admonition shortcode - Githubissues

welpo / tabi

A modern Zola theme with search, multilingual support, optional JavaScript, a perfect Lighthouse score, and a focus on accessibility.

https://welpo.github.io/tabi/

MIT License

97 stars 32 forks source link

✨ feat(shortcodes): add admonition shortcode #285

Closed welpo closed 3 months ago

welpo commented 3 months ago

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)
[X] 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

[X] I have verified the accessibility of my changes
[X] 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