Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Mar 7, 2024
1 parent df39a4a commit 3fdf037
Showing 1 changed file with 19 additions and 7 deletions.
26 changes: 19 additions & 7 deletions doc/emoji.nvim.txt
Original file line number Diff line number Diff line change
@@ -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*
Expand All @@ -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
Expand All @@ -30,13 +30,13 @@ FEATURES *emoji.nvim-features*

- Automatic updates of available emojis via GitHub actions (emojisource.app <https://emojisource.app/> as source).
- No dependencies (relies on `vim.ui.select`).
- (Optional) telescope.nvim <https://github.com/nvim-telescope/telescope.nvim> integration.
- (Optional) nvim-cmp <https://github.com/hrsh7th/nvim-cmp> integration.
- (Optional) telescope.nvim <https://github.com/nvim-telescope/telescope.nvim> integration (emojis only).
- (Optional) nvim-cmp <https://github.com/hrsh7th/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 <https://github.com/folke/lazy.nvim>
Expand Down Expand Up @@ -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.


Expand All @@ -104,6 +113,9 @@ CREDITS *emoji.nvim-credits*
Thanks to emojisource.app <https://emojisource.app/> for providing its emoji
API that is used in GitHub Actions to automatically update emojis.

Thanks to hines-r <https://github.com/hines-r> for providing kaomojis.json
<https://github.com/hines-r/kaomoji-api/blob/master/src/kaomoji.json>

Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>

vim:tw=78:ts=8:noet:ft=help:norl:

0 comments on commit 3fdf037

Please sign in to comment.