Site | Gem Page | GitHub Repo

Meet jekyll-uj-powertools, your new best friend for developing with Ultimate jekyll

• Powerful utility for Jekyll sites
• uj_strip_ads filter to remove ads from a string
• uj_json_escape filter to escape JSON characters

Meet jekyll-uj-powertools, the powerful set of utilities for Jekyll users.

It includes functions to remove ads from strings and escape JSON characters, making your Jekyll site cleaner and more efficient.

Install the gem and add to the application's Gemfile by executing:

bundle add jekyll-uj-powertools

If bundler is not being used to manage dependencies, install the gem by executing:

gem install jekyll-uj-powertools

Now you can use all the custom filters and variables provided by jekyll-uj-powertools in your Jekyll site.

Remove ads from a string, such as a blog post or article.

{{ post.content | uj_strip_ads }}

Escape JSON characters in a string making it safe to use in a JSON object.

{{ post.content | uj_json_escape }}

Convert a string to title case.

{{ "hello world" | uj_title_case }}

Process content with Liquid templating and Markdown conversion, automatically transforming markdown images to responsive uj_image tags.

{{ post.content | uj_content_format }}

This filter:

• Transforms markdown images ![alt](url) to {% uj_image "url", alt="alt", class="..." %}
• Automatically pulls image class from page.resolved.theme.blog.image.class
• Processes Liquid tags in the content
• Converts Markdown to HTML (for .md files)

If no class is specified in frontmatter, the uj_image tag will be rendered without a class attribute.

---
theme:
  blog:
    image:
      class: "img-fluid rounded-3 shadow"
---

With this frontmatter, all markdown images in the post will automatically use the specified class.

Use the site.uj.cache_breaker variable to append a cache-busting query parameter to your assets.

<link rel="stylesheet" href="{{ "/assets/css/style.css" | prepend: site.baseurl }}?v={{ site.uj.cache_breaker }}">

Generate a random ID for each page, useful for sorting randomly or for unique identifiers.

<!-- Sort pages in a random order -->
{% assign sorted_pages = site.pages | sort: "random_id" %}
{% for page in sorted_pages %}
  <h2>{{ page.title }}</h2>
  <p>Random ID: {{ page.random_id }}</p>
  <p>{{ page.content }}</p>
{% endfor %}

Get the file extension of the current page, useful for determining how to process or display the page.

<!-- Check the extension of a page -->
{% if page.extension == "html" %}
  <p>This is an HTML page.</p>
{% elsif page.extension == "md" %}
  <p>This is a Markdown page.</p>
{% endif %}

Access the layout data of the page object, which can be useful for accessing layout-specific variables when looping through pages.

<!-- Loop through pages and access the layout data of each page -->
{% for page in site.pages %}
  <h2>{{ page.title }}</h2>
  <p>{{ page.layout_data.description }}</p>
{% endfor %}

Resolves the site, layout, and page data into a single object, which can be useful for accessing all the information about the current page in one place.

<!-- New Way -->
{{ page.resolved.my.variable }}

<!-- Old Way -->
{{ page.my.variable | default: layout.my.variable | default: site.my.variable }}

A custom Liquid tag that checks if a variable is truthy (not nil, not false, not empty string, not 0) and renders the content inside the tag if it is truthy.

{% iftruthy my_variable %}
  <p>This content will only be rendered if my_variable is truthy.</p>
{% endiftruthy %}

A custom Liquid tag that checks if a variable is falsy (nil, false, empty string, or 0) and renders the content inside the tag if it is falsy.

{% iffalsy my_variable %}
  <p>This content will only be rendered if my_variable is falsy.</p>
{% endifalsy %}

A custom Liquid tag that renders a Font Awesome icon with the specified style and name. It supports name and class parameters.

{% uj_icon "rocket", "fa-lg me-2" %}

Generates a fake comment count based on content word count for demonstration purposes.

{% uj_fake_comments %}
{% uj_fake_comments page.content %}

Renders responsive images with WebP support and lazy loading.

{% uj_image "/assets/images/hero.jpg", max_width="1024", alt="Hero image" %}
{% uj_image page.featured_image, class="img-fluid", webp="false" %}

Converts ISO language codes to language names in English or native format.

{% uj_language "es" %}
{% uj_language page.language, "native" %}

Retrieves member information from site team collection.

{% uj_member "john-doe", "name" %}
{% uj_member page.author, "url" %}
{% uj_member member_id, "image" %}
{% uj_member "john-doe", "image-tag", max_width="640", class="team-photo" %}

The image-tag property renders a responsive image using the uj_image tag with all its features (WebP, lazy loading, responsive sizes). You can pass any uj_image options as additional parameters.

Fetches post data from site collections.

{% uj_post "my-post-slug", "title" %}
{% uj_post post.id, "description" %}
{% uj_post current_post, "image-url" %}

Calculates estimated reading time based on content (200 words per minute).

{% uj_readtime %}
{% uj_readtime page.content %}

Generates social media URLs from platform handles.

{% uj_social "twitter" %}
{% uj_social "github" %}

Creates language-specific URLs for multilingual sites.

{% uj_translation_url "es", page.url %}
{% uj_translation_url target_lang, "/pricing" %}

These examples show how you can use the features of jekyll-uj-powertools in your Jekyll site.

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install.

Run the tests

bundle install && bundle exec rspec

Test in your Ultimate Jekyll Site

npm start -- --ujPluginDevMode=true

To release a new version, update the version number in the .gemspec and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

# Release
bundle exec rake release

# Clear the files in the pkg folder
rm -rf pkg/*

Bug reports and pull requests are welcome on GitHub at https://github.com/itw-creative-works/jekyll-uj-powertools.

• ITW Creative Works
• Somiibo
• Slapform
• StudyMonkey
• DashQR
• Replyify
• SoundGrail
• Trusteroo

Ask us to have your project listed! :)