ronisbr / emojify.nvim

Plugin to emojify buffers in Neovim

Emojify.nvim

This package adds the capability to emojify the buffers considering the Github markdown emoji codes. Notice that it uses Neovim extended mark capability, meaning the buffer is not modified.

After enabling emojify, :sparkles: will be rendered as ✨, for example.

Installation

The recommended way to install the plugin is using lazy.nvim as plugin manager:

{
  "ronisbr/emojify.nvim",
  cmd = "Emojify",
  config = function ()
    require("emojify").setup({
      inlay = false
    })
  end,
  lazy = true,
}

The inlay option selects how the system will display the emoji.

If inlay = false, it will replace the text. In this case, this plugin requires conceallevel 1 or 2 to work properly. To set it, execute: :set conceallevel=1 or :set conceallevel=2.

If inlay = true, it will add a inline text right after the emoji. This feature requires Neovim 0.10.

Usage

Execute :Emojify to toggle the emojify mode.

Screenshot

The figure to the left shows a Neogit log without emojify mode whereas the figure to the right shows the same buffer with emojify enabled.

References

This plugin was inspired by emacs-emojify.