{"id":13646687,"url":"https://github.com/iqbalansari/emacs-emojify","last_synced_at":"2026-03-11T08:36:29.377Z","repository":{"id":44217959,"uuid":"44763224","full_name":"iqbalansari/emacs-emojify","owner":"iqbalansari","description":"Display emojis in Emacs","archived":false,"fork":false,"pushed_at":"2022-10-11T17:27:02.000Z","size":34105,"stargazers_count":417,"open_issues_count":37,"forks_count":38,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-21T21:38:29.180Z","etag":null,"topics":["elisp","emacs","emojis"],"latest_commit_sha":null,"homepage":null,"language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/iqbalansari.png","metadata":{"files":{"readme":"README.org","changelog":"CHANGELOG.org","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-10-22T17:55:10.000Z","updated_at":"2025-02-20T12:25:32.000Z","dependencies_parsed_at":"2023-01-19T22:46:25.897Z","dependency_job_id":null,"html_url":"https://github.com/iqbalansari/emacs-emojify","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/iqbalansari/emacs-emojify","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqbalansari%2Femacs-emojify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqbalansari%2Femacs-emojify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqbalansari%2Femacs-emojify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqbalansari%2Femacs-emojify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iqbalansari","download_url":"https://codeload.github.com/iqbalansari/emacs-emojify/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iqbalansari%2Femacs-emojify/sbom","scorecard":{"id":494088,"data":{"date":"2025-08-11","repo":{"name":"github.com/iqbalansari/emacs-emojify","commit":"1b726412f19896abf5e4857d4c32220e33400b55"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.7,"checks":[{"name":"Code-Review","score":3,"reason":"Found 7/22 approved changesets -- score normalized to 3","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/ci.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: GNU General Public License v3.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/iqbalansari/emacs-emojify/ci.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ci.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/iqbalansari/emacs-emojify/ci.yml/master?enable=pin","Warn: downloadThenRun not pinned by hash: .github/workflows/ci.yml:32","Warn: downloadThenRun not pinned by hash: .github/workflows/ci.yml:44","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 downloadThenRun dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v1.2 not signed: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/17481459","Warn: release artifact v1.0 not signed: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/10183373","Warn: release artifact v0.4 not signed: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/4247721","Warn: release artifact v0.3 not signed: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/2319413","Warn: release artifact v0.2 not signed: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/2128237","Warn: release artifact v1.2 does not have provenance: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/17481459","Warn: release artifact v1.0 does not have provenance: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/10183373","Warn: release artifact v0.4 does not have provenance: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/4247721","Warn: release artifact v0.3 does not have provenance: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/2319413","Warn: release artifact v0.2 does not have provenance: https://api.github.com/repos/iqbalansari/emacs-emojify/releases/2128237"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 15 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-19T20:00:00.685Z","repository_id":44217959,"created_at":"2025-08-19T20:00:00.685Z","updated_at":"2025-08-19T20:00:00.685Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30376313,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-11T06:09:32.197Z","status":"ssl_error","status_checked_at":"2026-03-11T06:09:17.086Z","response_time":84,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elisp","emacs","emojis"],"created_at":"2024-08-02T01:03:03.268Z","updated_at":"2026-03-11T08:36:29.268Z","avatar_url":"https://github.com/iqbalansari.png","language":"Emacs Lisp","funding_links":[],"categories":["Emacs Lisp"],"sub_categories":[],"readme":"* Emojify\n\n[[./CHANGELOG.org][file:https://img.shields.io/badge/version-v0.4-blue.svg]] [[https://melpa.org/#/emojify][file:https://melpa.org/packages/emojify-badge.svg]] [[http://stable.melpa.org/#/emojify][file:http://stable.melpa.org/packages/emojify-badge.svg]] [[https://travis-ci.org/iqbalansari/emacs-emojify][https://travis-ci.org/iqbalansari/emacs-emojify.svg?branch=master]] [[https://coveralls.io/github/iqbalansari/emacs-emojify?branch=master][https://coveralls.io/repos/github/iqbalansari/emacs-emojify/badge.svg?branch=master]] [[http://www.gnu.org/licenses/gpl-3.0.html][http://img.shields.io/:license-gpl3-blue.svg]] [[http://makeapullrequest.com][file:https://img.shields.io/badge/PRs-welcome-brightgreen.svg]]\n\n** Table of contents                                              :TOC_3_gh:\n- [[#emojify][Emojify]]\n  - [[#what-is-this][What is this?]]\n  - [[#what-does-it-look-like][What does it look like?]]\n  - [[#requirements][Requirements]]\n  - [[#installation][Installation]]\n    - [[#elpa][ELPA]]\n  - [[#usage][Usage]]\n    - [[#displaying-emojis][Displaying emojis]]\n    - [[#searching-emojis][Searching emojis]]\n    - [[#inserting-emojis][Inserting emojis]]\n    - [[#describing-emojis][Describing emojis]]\n    - [[#listing-all-emojis][Listing all emojis]]\n  - [[#customizations][Customizations]]\n    - [[#displaying-composed-text-as-emojis][Displaying composed text as emojis]]\n    - [[#displaying-emojis-in-company-mode-tooltips][Displaying emojis in company mode tooltips]]\n    - [[#configuring-the-types-of-emojis-displayed][Configuring the types of emojis displayed]]\n    - [[#configuring-how-emojis-are-displayed][Configuring how emojis are displayed]]\n    - [[#configuring-the-buffers-where-emojify-mode-is-enabled][Configuring the buffers where emojify mode is enabled]]\n    - [[#configuring-the-texts-that-are-displayed-as-emojis][Configuring the texts that are displayed as emojis]]\n    - [[#customizing-the-behaviour-when-point-enters-an-emoji][Customizing the behaviour when point enters an emoji]]\n    - [[#customizing-the-behaviour-during-isearch-mode][Customizing the behaviour during isearch-mode]]\n    - [[#customizing-the-behaviour-when-mouse-hovers-over-an-emoji][Customizing the behaviour when mouse hovers over an emoji]]\n    - [[#custom-emojis][Custom emojis]]\n  - [[#known-issues][Known issues]]\n  - [[#contributing][Contributing]]\n  - [[#thanks][Thanks]]\n  - [[#credits][Credits]]\n  - [[#licence][Licence]]\n    - [[#emojione-images][EmojiOne images]]\n    - [[#twemoji-images][Twemoji images]]\n    - [[#source-code][Source code]]\n\n** What is this?\n   Emojify is an Emacs extension to display emojis. It can display github style\n   emojis like ~:smile:~ or plain ascii ones like ~:)~. It tries to be as\n   efficient as possible, while also providing a lot of [[#customizations][flexibility]]\n\n** What does it look like?\n   Here is how the commit log of this project looks with emojify mode enabled\n\n   [[https://raw.githubusercontent.com/iqbalansari/emacs-emojify/master/screenshots/emojify-in-action.png][screenshots/emojify-in-action.png?raw=true]]\n\n   If you prefer a GIF you can view one [[https://raw.githubusercontent.com/iqbalansari/emacs-emojify/master/screenshots/emojify-in-action.gif][here]].\n\n** Requirements\n   This package requires Emacs *v24.3* and above. Emacs should be compiled with\n   support for *PNG* images to display emojis as images. It is *recommended*\n   that Emacs is compiled with *ImageMagick* support. ~emojify~ will use it to\n   resize emojis if needed, additionally imagemagick is used to set background\n   color for emojis to workaround the bug described in [[https://github.com/iqbalansari/emacs-emojify/issues/7][issue 7]]. However these\n   are *completely optional*.\n\n   PNG support might require some additional steps to on Windows, you might find\n   [[http://stackoverflow.com/questions/2650041/emacs-under-windows-and-png-files][this]] stackoverflow answer helpful.\n\n** Installation\n*** ELPA\n    ~emojify~ is available on [[http://melpa.org/#/emojify][MELPA]] and [[http://stable.melpa.org/#/emojify][MELPA Stable]]. Please follow the instructions on MELPA\n    [[http://melpa.org/#/getting-started][website]] to enable it, if you haven't already.\n\n    You can then install ~emojify~ from the [[https://www.gnu.org/software/emacs/manual/html_node/emacs/Package-Menu.html][package menu]]. Alternatively install it by doing the following\n\n    Refresh the package index\n    #+BEGIN_QUOTE\n    M-x package-refresh-contents RET\n    #+END_QUOTE\n\n    And then install it by doing\n    #+BEGIN_QUOTE\n    M-x package-install RET emojify\n    #+END_QUOTE\n**** With use-package\n#+begin_src elisp\n(use-package emojify\n  :hook (after-init . global-emojify-mode))\n#+end_src\n** Usage\n*** Displaying emojis\n    ~emojify-mode~ can be enabled/disabled separately for a buffer by using the\n    command ~emojify-mode~, to enable/disable it globally use the command\n    ~global-emojify-mode~.\n\n    To enable ~emojify-mode~ globally at startup add something like the\n    following to your ~init~ file\n\n    #+BEGIN_SRC emacs-lisp\n      (add-hook 'after-init-hook #'global-emojify-mode)\n    #+END_SRC\n\n    Emojify integrates with packages like ~prettify-symbol-mode~ and\n    ~org-bullets-mode~ which display text differently, if the alternate text\n    displayed by these packages match an emoji, ~emojify~ will display them too.\n    See [[#displaying-composed-text-as-emojis][Displaying composed text as emojis]] for more details. Emojify can also\n    display emojis in ~company-mode~ tooltips, see [[#displaying-emojis-in-company-mode-tooltips][Displaying emojis in company mode tooltips]]\n    for more details.\n\n    *[EXPERIMENTAL]* Emojify can be used for displaying emojis in the mode-line,\n    to enable/disable it for individual buffers use the command\n    ~emojify-mode-line-mode~, to enable/disable it globally use the command\n    ~global-emojify-mode-line-mode~.\n\n*** Searching emojis\n    The command ~emojify-apropos-emoji~ can be used to display emojis that match\n    given regexp/apropos pattern. The results are displayed in a specialized\n    buffer, where ~w~ or ~c~ can be used to copy emojis to the kill ring.\n\n*** Inserting emojis\n    The command ~emojify-insert-emoji~ can be used to insert emojis\n    interactively. While the command works with vanilla Emacs completion system,\n    the experience would be better with something like [[https://github.com/emacs-helm/helm][Helm]], [[https://github.com/abo-abo/swiper][Ivy]], [[https://www.emacswiki.org/emacs/Icicles][Icicles]] or Ido\n    depending on you preference.\n\n*** Describing emojis\n    The command ~emojify-describe-emoji-at-point~ can be used to view\n    explanation about the command displayed at point. Additionally the command\n    ~emojify-describe-emoji~ can be used to display description for an arbitrary\n    emoji.\n\n*** Listing all emojis\n    The command ~emojify-list-emojis~ can be used to view all the available emojis\n    in a list form.\n\n** Customizations\n*** Displaying composed text as emojis\n    Emacs provides a way to modify how some parts of buffer are displayed using\n    the ~composition~ text property. ~prettify-symbol-mode~ and\n    ~org-bullets-mode~ are some popular packages that use this feature to\n    display certain text in the buffer differently.\n\n    If the alternate display matches an emoji then ~emojify~ will display those\n    as emojis too. This is default behaviour. You can disable this behaviour by\n    setting ~emojify-composed-text-p~ to ~nil~.\n\n*** Displaying emojis in company mode tooltips\n    Emojify can also display emojis that are part of company-mode's completion\n    tooltip (see [[https://github.com/dunn/company-emoji][company-emoji]] for an example of such tooltips). However this\n    feature is turned off by default. To turn it on set\n    ~emojify-company-tooltips-p~ to ~t~.\n\n*** Configuring the types of emojis displayed\n    Emojify by default displays plain text emojis (~:)~), unicode emojis (~😄~)\n    and github style emojis ~:smile:~. However this is customizable. You can do\n    so by changing the value of ~emojify-emoji-styles~ using the customize\n    interface. To change the value of the variable from Lisp using the function\n    ~emojify-set-emoji-styles~ (or set it before loading ~emojify~), call it with\n    one parameter the list of styles that you want to be displayed. The possible\n    styles are\n\n    - ascii            - Display only plain ascii emojis\n    - unicode          - Display only unicode emojis\n    - github           - Display only github style emojis\n\n*** Configuring how emojis are displayed\n    By default emojis are displayed using images. However you can instruct emojify\n    to display it using unicode characters or ascii characters. To do so customize\n    the variable ~emojify-display-style~.\n\n    You can set it one of the following values\n    - image   - Display emojis using images, obviously this requires the Emacs\n                instance to support image\n    - unicode - Display emojis using unicode characters, this might be a good\n                option on platforms with good emoji fonts\n    - ascii   - This is simplest and does not require any external dependencies\n                In this case emojify will display ascii equivalents of github\n                style emojis.\n\n*** Configuring the buffers where emojify mode is enabled\n    You can control the buffers where emojify is enabled using\n    ~emojify-inhibit-major-modes~ and ~emojify-inhibit-in-buffer-functions~.\n\n**** Major modes where emojify-mode should be not be enabled\n     As the names suggests ~emojify-inhibit-major-modes~ is a list of major-modes\n     where ~emojify~ should not be enabled.\n\n**** Inhibiting emojify-mode using custom functions\n     ~emojify-inhibit-in-buffer-functions~ is a list of functions that ~emojify~\n     calls before enabling ~emojify-mode~ in a buffer. If any of the functions\n     return a non-nil value ~emojify-mode~ is not enabled in the buffer. Users\n     can add custom functions to this list if they wish to inhibit ~emojify~ in\n     certain buffers. The functions are called with one argument the buffer\n     where ~emojify-mode~ is about to be enabled.\n\n*** Configuring the texts that are displayed as emojis\n    ~emojify~ offers two variables to inhibit the display of certain emojis.\n\n**** Controlling the display of emojis in programming modes\n     If enabled in programming modes ~emojify~ by default will display only emojis\n     in string and comments. This behaviour can be customized using the variable\n     ~emojify-prog-contexts~. The variable can be set to one of the following values\n\n     - comments - Display emojis only in comments\n     - string   - Display emojis only in string\n     - both     - Display emojis in comments as well as string\n     - none     - Do not display emojis in programming modes\n\n**** Inhibiting display of emojis using custom functions\n     ~emojify-inhibit-functions~ is a list of function ~emojify~ calls before\n     displaying certain text as emoji, if any of the functions return a non-nil\n     value the corresponding text is not displayed as emoji. Users can add\n     custom functions to this list, if they inhibit display of emojis in under\n     certain conditions. The functions are called with three arguments\n\n     - text - The text that is about to be displayed as an emoji\n     - beg  - The beginning point of text in the buffer\n     - end  - The ending point of text in the buffer\n\n     These functions are called with the buffer where emoji is being displayed\n     selected.\n\n*** Customizing the behaviour when point enters an emoji\n    The behaviour when point enters an emoji can be customized using the\n    variable ~emojify-point-entered-behaviour~. It can have one of the following\n    values\n\n    - echo    - Display the emojified text in the minibuffer\n    - uncover - Temporarily display the underlying text while point is in the emojified text\n\n    Additionally it can be set to a custom function, the function is called with\n    two parameters (the buffer where the emoji appears is selected while running\n    the function)\n\n    - beg    - The beginning position of the text displayed as emoji\n    - end    - The ending position of the text displayed as emoji\n\n    The return value of the function is ignored.\n\n    *Note:* The custom function will be called for once for each character in an\n    emoji as point moves through them. Avoid manipulating the buffer in these\n    functions\n\n*** Customizing the behaviour during isearch-mode\n    By default in isearch-mode the underlying emoji is displayed temporarily\n    when point enters the emoji while searching (similar to ~uncover~ behaviour\n    mentioned [[#controlling-behaviour-when-point-enters-an-emoji][above]]). This can be disabled by setting\n    ~emojify-reveal-on-isearch~ to ~nil~.\n\n*** Customizing the behaviour when mouse hovers over an emoji\n    When mouse hovers over a emoji, the underlying text is displayed in a help\n    popup. This behaviour can be disabled by setting ~emojify-show-help~ to nil.\n\n*** Custom emojis\n    You can specify custom emojis using the ~emojify-user-emojis~ variable.  You\n    need to set it to an alist where first element of cons is the text to be\n    displayed as emoji, while the second element of the cons is an alist\n    containing data about the emoji.\n\n    The inner alist should have atleast\n\n    1) \"name\"  - The name of the emoji\n    2) \"style\" - This should be one of \"github\", \"ascii\" or \"github\"\n\n    Additionally the alist should contain one of (see [[#configuring-the-types-of-emojis-displayed][emojify-display-style]])\n    1) \"unicode\" - The replacement for the provided emoji for \"unicode\" display style\n    2) \"image\"   - The replacement for the provided emoji for \"image\" display style.\n                   This should be the *absolute* path to the image\n    3) \"ascii\"   - The replacement for the provided emoji for \"ascii\" display style\n\n    It is best to set this variable before you load ~emojify~, in case you set\n    this variable after loading ~emojify~ run the function\n    ~emojify-set-emoji-data~ to recalculate emoji data.\n\n    User emojis take precedence over default emojis so the above mechanism can\n    also be used to override the default emojis\n\n**** Example\n     Below is an example of setting up custom emojis. Assuming that the custom\n     images are at ~\\~/.emacs.d/emojis/trollface.png~ and\n     ~\\~/.emacs.d/emojis/neckbeard.png~, you instruct ~emojify~ to display ~:trollface:~\n     and ~:neckbeard:~ as :trollface: and :neckbeard:\n\n     #+BEGIN_SRC emacs-lisp\n       (setq emojify-user-emojis '((\":trollface:\" . ((\"name\" . \"Troll Face\")\n                                                     (\"image\" . \"~/.emacs.d/emojis/trollface.png\")\n                                                     (\"style\" . \"github\")))\n                                   (\":neckbeard:\" . ((\"name\" . \"Neckbeard\")\n                                                     (\"image\" . \"~/.emacs.d/emojis/neckbeard.png\")\n                                                     (\"style\" . \"github\")))))\n\n       ;; If emojify is already loaded refresh emoji data\n       (when (featurep 'emojify)\n         (emojify-set-emoji-data))\n     #+END_SRC\n\n** Known issues\n   - Emojis are not properly updated after customizing ~emojify-display-style~ or\n     ~emojify-program-contexts~. For time being you will be fine as long as you\n     set these variables before ~emojify~ has loaded.\n   - Some of the emojis prompted in the commands like ~emojify-insert-emoji~ might\n     not be displayed by ~emojify~, this might happen if you have newer emoji\n     data but old set of images. Download the latest emoji image using ~emojify-download-emoji~\n     and set ~emojify-emoji-set~ to the downloaded set.\n\n** Contributing\n   Code as well as documentation contributions are welcome.\n\n   [[https://github.com/cask/cask][Cask]] is used to manage project dependencies so make sure you have it\n   installed. To run the tests you need to install the dependencies by running\n   the following\n\n   #+BEGIN_SRC sh\n     cask install\n   #+END_SRC\n\n   After the installation completes you can run the tests by running the\n   following command\n\n   #+BEGIN_SRC sh\n     cask exec ert-runner\n   #+END_SRC\n\n** Thanks\n   Special thanks to @ryanprior for bug reports and valuable feedback on the\n   issue tracker.\n\n** Credits\n   Emoji set designed and offered free by [[http://emojione.com][Emoji One]].\n\n** Licence\n*** EmojiOne images\n    The emoji images are distributed under [[http://creativecommons.org/licenses/by-sa/4.0/][Creative Commons License]] (CC-BY-SA).\n\n*** OpenMoji images\n    All emojis designed by [[https://openmoji.org/][OpenMoji]] – the open-source emoji and icon project. License: [[https://creativecommons.org/licenses/by-sa/4.0/#][CC BY-SA 4.0]]\n\n*** Twemoji images\n    Copyright 2018 Twitter, Inc and other contributors\n    Code licensed under the MIT License: http://opensource.org/licenses/MIT\n    Graphics licensed under CC-BY 4.0: https://creativecommons.org/licenses/by/4.0/\n\n*** Source code\n    The source code is distributed under [[http://www.gnu.org/licenses/quick-guide-gplv3.html][GNU General Public License v3]]. See [[LICENSE][LICENSE]].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiqbalansari%2Femacs-emojify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiqbalansari%2Femacs-emojify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiqbalansari%2Femacs-emojify/lists"}