This plugin substitutes text emoticons, also known as smilies like :-), with images.
Smileys, also known as "emoticons," are pictorial representation of facial expressions to convey emotions in your writing. They are a great way to brighten up texts.
Text smileys are created by typing two or more punctuation marks. Some examples are:
:-) :D :'-( <3
By default, Grav Smileys Plugin automatically converts text smileys to graphic images. When you type ;-) in your page you see a smile emoticon when you preview or publish your page.
Further it comes with a pre-configured set of example smileys (using Grav Smileys Data Pack -- Simple Smileys). An unlimited amount of custom smileys can be setup as well.
If you want, you can add your own smileys by importing ready to use packages available around the Internet. Currently available are:
Installing or updating the TSmileys plugin can be done in one of two ways. Using the GPM (Grav Package Manager) installation update method (i.e. bin/gpm install smileys) or manual install by downloading this plugin and extracting all plugin files to
user/plugins/smileys
For more informations, please check the Installation and update guide.
The Smileys plugin comes with some sensible default configuration, that are pretty self explanatory:
# Global plugin configurations
enabled: true # Set to false to disable this plugin completely
built_in_css: true # Use built-in CSS of the plugin
weight: 1 # Set the weight (order of execution)
# Default values for Smileys configuration.
pack: simple_smileys # The name of the smileys package
# Global and page specific configurations
process: true # Filter smileys
exclude:
tags: [code, pre] # Exclude tags from smiley replacement
classes: [mathjax, latex] # Exclude classes from smiley replacementIf you need to change any value, then the best process is to copy the smileys.yaml file into your users/config/plugins/ folder (create it if it doesn't exist), and then modify there. This will override the default settings.
If you want to alter the settings for one or a few pages only, you can do so by adding page specific configurations into your page headers, e.g.
smileys:
process: falseto switch off Smileys plugin just for this page.
Something you might want to do is to override the look and feel of the external links, and with Grav it is super easy.
Copy the stylesheet assets/css/smileys.css into the css folder of your custom theme and add it to the list of CSS files.
user/themes/custom-theme/css/smileys.css
After that set the built_in_css option of the Smileys plugin to false. That's it.
You can now edit, override and tweak it however you prefer. Smiley images provide the CSS class smileys to style your smileys differently from other images.
You can contribute at any time! Before opening any issue, please search for existing issues and review the guidelines for contributing.
After that please note:
- If you find a bug, would like to make a feature request or suggest an improvement, please open a new issue. If you have any interesting ideas for additions to the syntax please do suggest them as well!
- Feature requests are more likely to get attention if you include a clearly described use case.
- If you wish to submit a pull request, please make again sure that your request match the guidelines for contributing and that you keep track of adding unit tests for any new or changed functionality.
If you like my project, feel free to support me via
Thanks!
Copyright (c) 2015 Benjamin Regler. See also the list of contributors who participated in this project.
Dual-licensed for use under the terms of the MIT or GPLv3 licenses.
