Jekyll_todo

Generates a TODO block.

Options

• alert - Apply the alert class to the generated HTML wrapper
• block - Apply display: block to the generated HTML wrapper
• class - Apply the given class to the generated HTML wrapper
• id - Apply the given HTML id attribute to the generated HTML wrapper

• mode - Only generate the notice for the given Jekyll mode. The default is to generate the notice for all Jekyll modes. For example:

  • mode=development or mode=develop only generates the notice when in development mode.
  • mode=production or mode=prod only generates the notice when in production mode.

• span - Apply display: inline to the generated HTML wrapper

• style - Apply the given CSS style to the generated HTML wrapper

Examples

{% todo %}
  blah blah blah
{% endtodo %}

Example:

{% todo id='todo1' %}
  blah blah blah
{% endtodo %}

See demo/index.html for more examples.

Installation

Add the following to your Jekyll website's Gemfile:

group :jekyll_plugins do
  gem 'jekyll_todo'
end

And then execute:

$ bundle

Usage

Describe how to use this gem

Development

After checking out this git repository, install dependencies by typing:

$ bin/setup

You should do the above before running Visual Studio Code.

Run the Tests

$ bundle exec rake test

Interactive Session

The following will allow you to experiment:

$ bin/console

Local Installation

To install this gem onto your local machine, type:

$ bundle exec rake install

To Release A New Version

To create a git tag for the new version, push git commits and tags, and push the new version of the gem to https://rubygems.org, type:

$ bundle exec rake release

Contributing

Bug reports and pull requests are welcome at https://github.com/mslinn/jekyll_todo.

License

The gem is available as open source under the terms of the MIT License.