Skip to content

Latest commit

 

History

History
108 lines (86 loc) · 4.1 KB

README.md

File metadata and controls

108 lines (86 loc) · 4.1 KB
Raw




Site | Gem Page | GitHub Repo

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

🦄 Features

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

🌐 Jekyll::uj-powertools

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.

📦 Installation

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

⚡️ Usage

Now you can use the uj_strip_ads and uj_json_escape filters in your Jekyll site:

uj_strip_ads Filter

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

{{ post.content | uj_strip_ads }}

uj_json_escape Filter

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

{{ post.content | uj_json_escape }}

uj_title_case Filter

Convert a string to title case.

{{ "hello world" | uj_title_case }}

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

🔧 Development

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. To release a new version, update the version number in version.rb, 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.

⚠️ Testing

Run the tests

bundle install
bundle exec rspec

💎 Build + Publish the Gem

# Build the gem
gem build jekyll-uj-powertools.gemspec

# Publish the gem where X.X.X is the version number
gem push jekyll-uj-powertools-X.X.X.gem

🗨️ Contributing

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

📚 Projects Using this Library

Ask us to have your project listed! :)