Shortcodes
Reusable Jekyll includes — same idea as a WordPress shortcode. Each one bundles the HTML structure and CSS class together so you never hand-type the wrapper markup in a post, and every usage stays visually consistent site-wide.
Usage: paste the {% include ... %} line directly into a post body, same place as any paragraph.
{% include youtube.html id="VIDEO_ID" %}
Responsive YouTube embed, 16:9, scales to the width of the text column.
id(required) — the video ID from the YouTube URL (the part afterv=, or from the Share → Embed button).
{% include youtube.html id="dQw4w9WgXcQ" %}
{% include image.html src="/assets/images/photo.jpg" alt="description" caption="Optional caption or credit" %}
Full-width responsive image with an optional caption underneath.
src(required) — path to the image, usually under/assets/images/.alt(required) — accessibility text, describes the image for screen readers.caption(optional) — small text under the image, e.g. a photo credit.
{% include image.html src="/assets/images/bridge.jpg" alt="A large bridge over a large body of water" caption="Photo by Enguerrand Photography on Unsplash" %}
{% include pull-quote.html text="The line you want pulled out." attribution="Optional source" %}
A visually distinct pulled quote — left border in the accent colour, italic, breaks out of the regular paragraph flow. For a striking line worth setting apart, not for the subtitle/epigraph (that’s the post’s own front matter).
text(required) — the quoted line.attribution(optional) — who said it / where it’s from, shown smaller underneath.
{% include pull-quote.html text="The survival was not meant to be the whole story. It was meant to be the floor." %}
{% include divider.html %}
The centred diamond (❖) scene-break, used throughout the Black Cat pieces to mark a section shift within a post.
No parameters.
{% include divider.html %}
{% include callout.html text="The aside you want to highlight." label="Optional label, e.g. Note" %}
A bordered, tinted box for an editorial aside from the writer — distinct from a blockquote (which quotes someone else) and from a pull-quote (which pulls a line out of the writer’s own prose to emphasise it). Full background tint, rounded corners, optional uppercase label above the text.
text(required) — the callout content.label(optional) — small uppercase label above the text, e.g. “Note,” “Aside.”
{% include callout.html label="Note" text="Worth knowing before you read further." %}
Native markdown, styled without a shortcode
Two elements get their look automatically, no {% include %} needed:
- Blockquote (
> quoted text) — bootcamp convention: accent left border, tinted background, small radius. Use for actually quoting someone, not for pulling your own line (that’spull-quote.html). - Fenced code blocks (
``language `) — syntax highlighted automatically via Rouge (kramdown’s built-in highlighter), coloured to match the site’s warm palette instead of a default cool-toned theme.
Dev note (.dev-note)
A muted aside for working docs like the style guide — an explanation of a decision or a caveat, visually distinct from real body content so it doesn’t read as prose. Not a shortcode, just a raw HTML paragraph with a class:
<p class="dev-note"><span class="dev-note__label">Note</span> The note text goes here.</p>
Building this out as it’s needed — more shortcodes get added here as they’re built. Eventually intended to become a releasable Jekyll theme; this file is the usage documentation for that.