Skip to content
This repository has been archived by the owner on Sep 4, 2023. It is now read-only.

hugomodo/hugomodo-shortcode-partials

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HugoModo Shortcode Partials

Provides the default Hugo shortcodes as a collection of partials for use in templates.

Support on Patreon

Patreon

Support on Beerpay

Hey dude! Help me out for a couple of 🍻!

Beerpay Beerpay

What's the issue?

HugoModo strives for third-party compatibility. The baseline for this is currently Forestry CMS. When asking the question, "does it work with Forestry CMS?" of the Image Processing extension, the answer was not yes - it was mostly.

The problem is, Forestry is unaware of shortcodes. These could be hand-typed by a developer easily, but when it comes to non-technical authors adding images to content, they probably aren't going to do that. And as a matter of usability, I also prefer to use the GUI to add content to a post. On Forestry, this results in a markdown declaration.

No assessment of the size of the image is performed, and so the result is the raw output of - more than likely - an oversized image.

HugoModo Image Processing aims to circumvent that issue with an interpreter of its own for outputting content. But while this interpreter then succeeds in producing resized image resources, it breaks all of the other shortcodes that can be used in Hugo.

The solution

HugoModo Shortcode Partials aims to provide all of the existing Hugo shortcodes as partials, as well as an override for content interpretation. This solves the problem above, and provides a clear best practise for adding additional shortcodes.

This is not recommended

Where absolutely possible, it is better to do without overriding Hugo's own .Content function. Using this shim and/or the Image Processing override may lead to a severe decrease in performance.

It is provided as a convenience, for anywhere markdown reinterpretation is preferred.

About

Provides the default Hugo shortcodes as a collection of partials for use in templates

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages