No commit activity in last 3 years
No release in over 3 years
Liquid tag for single-line comments
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.6
>= 0
>= 0

Runtime

>= 0
 Project Readme

Octopress Comment Tag

A single-line comment tag for Liquid.

Build Status Gem Version License

Why? Because sometimes a single line is all you need and this:

{% comment %}This is a short comment about whatever{% endcomment %}

Is better like this:

{% _ This is a short comment about whatever %}

This is not the most interesting Liquid tag in the world, but it's the shortest and has the least amount of code, which is kind of cute.

Installation

Add this line to your application's Gemfile:

gem 'octopress-comment-tag'

And then execute:

$ bundle

Or install it yourself as:

$ gem install octopress-comment-tag

Next add it to your gems list in Jekyll's _config.yml

gems:
  - octopress-comment-tag

Usage

The underscore is the tag name.

{% _ This is a comment! %}
{% _// Add slashes or other non-word characters to make comments stand out better %}

Also, it's easy to comment out a liquid tag, for example, you can easily disable an include tag like this:

{% _ include some_file.html %}

Yep, that's it.

Oh, and this is the shortest possible comment.

{%_%}

It looks like an bug creature emoticon.

Contributing

I dare you to improve on this masterpiece of simplicity.