Installation - SaswatPadhi/jekyll_smilify GitHub Wiki

There are 3 simple steps to use smilify in your existing Jekyll powered website:

  1. Copy required files
  • Copy the content of plugins folder to the _plugins or plugins folder as per your configuration.
    This is the source code of the smilify plugin.
    [ Learn more about _plugins folder here:[https://github.com/mojombo/jekyll/wiki/Plugins ]
  • Copy the contents of source/images to the images folder in the root folder of your blog source.
    These are the smiley images to be used.
    [ Learn more about source folder here: https://github.com/mojombo/jekyll/wiki/Configuration ]
  • Copy the contents of source/_include to the _include folder.
    These files contain the descriptions of the smiley themes, mapping between the images and the text emoticons. [ Learn more about _include folder here: https://github.com/mojombo/jekyll/wiki/Configuration ]

2. **Choose a smiley theme** * `smilify` comes with 3 smiley packs, assembled from various sources. To use a particular smiley pack in your website, you just have to add one line to your `_config.yml`:
```ruby
    smileytheme: MSN        # Use the MSN smiley theme
```
This is not optional and there is no default value assumed. If you do not
specify a `smileytheme`, `smilify` will be simply turned off.



3. Apply the filter in your Liquid templates

  • For smilify to detect and smilify your text emoticons, your content must be passed through the smilify filter.
    How and where you apply the filter would depend on thw way you have organised your Liquid template, but for most people, changing _post.html and _page.html in the _layouts folder should just work.

    If you have something like {{ content }} somewhere in your layout, just pipe it through smilify, like: {{ content | smilify }}.
⚠️ **GitHub.com Fallback** ⚠️