diff --git a/doc/emoji.nvim.txt b/doc/emoji.nvim.txt index b1f163e..8e2add0 100644 --- a/doc/emoji.nvim.txt +++ b/doc/emoji.nvim.txt @@ -1,4 +1,4 @@ -*emoji.nvim.txt* For Neovim >= 0.9.0 Last change: 2024 March 05 +*emoji.nvim.txt* For Neovim >= 0.9.0 Last change: 2024 March 07 ============================================================================== Table of Contents *emoji.nvim-table-of-contents* @@ -15,8 +15,8 @@ emoji.nvim WHY *emoji.nvim-why* -This plugin allows you to easily search and insert emojis in your current -buffer. +This plugin allows you to easily search and insert emojis and kaomojis in your +current buffer. Though there are a couple of plugins (see |emoji.nvim-similar-plugins-and-inspiration|), I decided to make a 15th plugin @@ -30,13 +30,13 @@ FEATURES *emoji.nvim-features* - Automatic updates of available emojis via GitHub actions (emojisource.app as source). - No dependencies (relies on `vim.ui.select`). -- (Optional) telescope.nvim integration. -- (Optional) nvim-cmp integration. +- (Optional) telescope.nvim integration (emojis only). +- (Optional) nvim-cmp integration (emojis only). SCREENSHOTS *emoji.nvim-screenshots* -vim.uitelescopecmp +emojis via vim.uikaomojis via vin.uitelescope (emojis)cmp (emojis) INSTALLATION *emoji.nvim-installation* With Lazy.nvim @@ -82,10 +82,19 @@ For telescope integration load the extension via: USE *emoji.nvim-use* -1. `:InsertEmoji` respective `lua require("emoji").insert()`) or `:InsertEmojiByGroup` respective `lua require("emoji").insert_by_group()` allows you to select an emoji that is inserted at your cursor’s current position. + +EMOJIS ~ + +1. `:InsertEmoji` respective `lua require("emoji").insert()` or `:InsertEmojiByGroup` respective `lua require("emoji").insert_by_group()` allows you to select an emoji that is inserted at your cursor’s current position. 2. `:Telescope emoji` does the same but invokes Telescope instead of `vim.ui.select`. (if telescope.nvim is installed). 3. While in insert mode typing `:` triggers the auto-completion of nvim-cmp. (if nvim-cmp integration is enabled and configured). + +KAOMOJIS ~ + +1. `:InsertKaomoji` respective `lua require("emoji").insert_kaomoji()` +2. `:InsertKaomojiByGroup` respective `lua require("emoji").insert_kaomoji_by_group()` + You can also create key bindings to your liking. @@ -104,6 +113,9 @@ CREDITS *emoji.nvim-credits* Thanks to emojisource.app for providing its emoji API that is used in GitHub Actions to automatically update emojis. +Thanks to hines-r for providing kaomojis.json + + Generated by panvimdoc vim:tw=78:ts=8:noet:ft=help:norl: