Skip to content

Commit

Permalink
chore: Auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisgrieser committed Dec 21, 2023
1 parent 7e0c7a6 commit 4809b6b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions doc/spider.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Table of Contents *spider-table-of-contents*
1. nvim-spider |spider-nvim-spider-|
- Features |spider-nvim-spider--features|
- Installation |spider-nvim-spider--installation|
- UTF-8 support |spider-nvim-spider--utf-8-support|
- Configuration |spider-nvim-spider--configuration|
- Subword Text Object |spider-nvim-spider--subword-text-object|
- Notes on Operator-pending Mode|spider-nvim-spider--notes-on-operator-pending-mode|
Expand Down Expand Up @@ -112,6 +113,9 @@ INSTALLATION *spider-nvim-spider--installation*

-- packer
use { "chrisgrieser/nvim-spider" }

-- lazy.nvim
{ "chrisgrieser/nvim-spider", lazy = true },
<

No keybindings are created by default. Below are the mappings to replace the
Expand Down Expand Up @@ -143,6 +147,33 @@ default `w`, `e`, and `b` motions with this plugin’s version of them.
When using `function() require("spider").motion("w") end` as third argument of
the keymap, dot-repeatability will not work.

UTF-8 SUPPORT *spider-nvim-spider--utf-8-support*

For adding UTF-8 support for matching non-ASCII text, add rocks `luautf8` in
packer.nvim. Or add dependency <https://github.com/theHamsta/nvim_rocks> like
below, in lazy.nvim example.

>lua
-- packer
{ "chrisgrieser/nvim-spider", rocks = "luautf8" }

-- lazy.nvim
{
"chrisgrieser/nvim-spider",
lazy = true,
dependencies = {
"theHamsta/nvim_rocks",
event = "VeryLazy",
build = "pip3 install --user hererocks && python3 -mhererocks . -j2.1.0-beta3 -r3.0.0 && cp nvim_rocks.lua lua",
config = function()
local rocks = require("nvim_rocks")
rocks.ensure_installed("luautf8")
end,
}
},
<


CONFIGURATION *spider-nvim-spider--configuration*

The `.setup()` call is optional.
Expand Down

0 comments on commit 4809b6b

Please sign in to comment.