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
pluginsfolder to the_pluginsorpluginsfolder as per your configuration.
This is the source code of thesmilifyplugin.
[ Learn more about_pluginsfolder here:[https://github.com/mojombo/jekyll/wiki/Plugins ]
- Copy the contents of
source/imagesto theimagesfolder in the root folder of your blog source.
These are the smiley images to be used.
[ Learn more aboutsourcefolder here: https://github.com/mojombo/jekyll/wiki/Configuration ]
- Copy the contents of
source/_includeto the_includefolder.
These files contain the descriptions of the smiley themes, mapping between the images and the text emoticons. [ Learn more about_includefolder 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
smilifyto detect and smilify your text emoticons, your content must be passed through thesmilifyfilter.
How and where you apply the filter would depend on thw way you have organised your Liquid template, but for most people, changing_post.htmland_page.htmlin the_layoutsfolder should just work.
If you have something like{{ content }}somewhere in your layout, just pipe it throughsmilify, like:{{ content | smilify }}.