Skip to content

Instantly share code, notes, and snippets.

@ptsurbeleu
Last active Jan 16, 2018
Embed
What would you like to do?
Custom Liquid tag for Jekyll (warning)
# MIT License
# Copyright (c) 2018 Pavel Tsurbeleu and StaticPages Inc (staticpages.io)
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
# ABOUT
# This is a scenario-specific implementation of custom "warning" tag in Liquid to use
# with Jekyll v3.5.0 installations and above. To activate the plugin, save it into
# _plugins/ folder at the root of your Jekyll site, eq.: _plugins/warning_tag.rb
# Once activated, you can use it in any Markdown page like this:
# {% warning Be careful! %} (no quotes in the output)
# or
# {% warning "Be careful!" %} (if you need quotes in the output).
# Feel free to share your feedback, send pull requests (PR) or suggestions (if any).
module Jekyll
class WarningTag < Liquid::Tag
# ctor.
def initialize(tag_name, text, tokens)
super
@text = text
end
# Simply renders an HTML-wrapped warning message.
def render(context)
"<div class=\"warning\">
<strong>Warning:</strong> #{@text}
</div>"
end
end
end
# This snippet registers custom tag implementation of your choice.
Liquid::Template.register_tag('warning', Jekyll::WarningTag)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment