Installation - SaswatPadhi/jekyll_smilify GitHub Wiki
There are 3 simple steps to use smilify
in your existing Jekyll powered
website:
- Copy required files
- Copy the content of
plugins
folder to the_plugins
orplugins
folder as per your configuration.
This is the source code of thesmilify
plugin.
[ Learn more about_plugins
folder here:[https://github.com/mojombo/jekyll/wiki/Plugins ]
- Copy the contents of
source/images
to theimages
folder in the root folder of your blog source.
These are the smiley images to be used.
[ Learn more aboutsource
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 thesmilify
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 throughsmilify
, like:{{ content | smilify }}
.