Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pattex/jekyll-tagging

Jekyll plugin to automatically generate a tag cloud and tag pages.
https://github.com/pattex/jekyll-tagging

Last synced: 15 days ago
JSON representation

Jekyll plugin to automatically generate a tag cloud and tag pages.

Awesome Lists containing this project

README 

        
= jekyll-tagging



By Arne Eilermann  and Jens Wille 



jekyll-tagging is a Jekyll plugin, to add a tag cloud and per tag pages plus feeds to your Jekyll generated Website.



== Tags

This plugin does not reinvent Jekyll's tagging feature. It just makes it easy to use.



Add space-delimited lowercase tags to FrontMatter, e.g.



  ---

  author: Willow Rosenberg

  tags: feminism anti-capitalism witchcraft

  ---



== Usage



Install it:



  gem install jekyll-tagging



Add this line to your Jekyll project's Gemfile:



  gem 'jekyll-tagging'



Add the following to your _plugins/ext.rb file:



  require 'jekyll/tagging'



And in your _config.yml you have to define your layout used to generate tag pages like:



  tag_page_layout: tag_page

  tag_page_dir: tag



This will look for _layouts/tag_page.html, and use it to generate tag pages into the _site/tag directory.



Now you have a new filter called tag_cloud which you can use with the site object as argument in your layout to get a cloud of all your site's tags. The tags are linked to their related tag page. Furthermore, you have a tags filter which you can feed with a post or a page object to get a link list of all its tags.



You can optionally define a per tag Atom/RSS feed.  In your _config.yml define the following:



  tag_feed_layout: tag_feed

  tag_feed_dir: tag



(tag_page_dir and tag_feed_dir can have the same value.)



=== Pretty page links



If your Jekyll permalink configuration is set to something other than :pretty, and you still want to have pretty tag links define the following in your _config.yml:



  tag_permalink_style: pretty



=== Ignoring tags



Sometimes you don't want tag pages generated for certain pages. That's ok! Just add ignored_tags: [tags,to,ignore] to your _config.yml



=== Extra data on tag pages



You can attach extra data to generated tag pages by specifying tag_page_data in _config.yml (this also works for tag_feed_data). For example, you might want to exclude tag pages from being picked up by `jekyll-sitemap`:



  tag_page_data:

    sitemap: false



=== Example tag page layout



(Save this to _layouts/tag_page.html if using the _config.yml snippet above.)



  ---

  layout: default

  ---

  
{{ page.tag }}


  
    

      {% for post in page.posts %}

        
  • 

    {{ post.title }} ({{ post.date | date_to_string }} | Tags: {{ post | tags }})
    • 

      {% endfor %}

      



  


    {{ site | tag_cloud }}

  



=== Example layout of an Atom feed



(Save this to _layouts/tag_feed.xml if using the _config.yml snippet above.)



  ---

  layout: nil

  ---

  

  

   Your Title - {{ page.tag }}

   

   

   {{ site.time | date_to_xmlschema }}

   http://example.com/tag/{{ page.tag }}.html

   

     Author Here

   

   {% for post in page.posts %}

   

     {{ post.title }}

     

     {{ post.date | date_to_xmlschema }}

     http://example.com{{ post.id }}

     {{ post.content | xml_escape }}

   

   {% endfor %}

  



== Links





Documentation:: 

Source code:: 

RubyGem:: 



== License



=== The MIT License



Copyright (c) 2010-2012 University of Cologne,

Albertus-Magnus-Platz, 50923 Cologne, Germany



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.