Skip to content

Commit

Permalink
chore(docs): auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cbochs authored and github-actions[bot] committed Mar 6, 2023
1 parent 3fbcf97 commit 2625f35
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions doc/portal.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,10 @@ lazy.nvim ~
{
"cbochs/portal.nvim",
-- Ootional dependencies
dependencies = { "cbochs/grapple.nvim" },
dependencies = {
"cbochs/grapple.nvim",
"ThePrimeagen/harpoon"
},
}
<

Expand All @@ -88,7 +91,10 @@ packer ~
use {
"cbochs/portal.nvim",
-- Optional dependencies
requires = { "cbochs/grapple.nvim" },
requires = {
"cbochs/grapple.nvim",
"ThePrimeagen/harpoon"
},
}
<

Expand All @@ -98,6 +104,7 @@ vim-plug ~
Plug "cbochs/portal.nvim"
" Optional dependencies
Plug "cbochs/grapple.nvim"
Plug "ThePrimeagen/harpoon"
<


Expand Down Expand Up @@ -212,8 +219,8 @@ Examples ~

GRAPPLE

Filter, match, and iterate over tagged files from harpoon
<https://github.com/cbochs/grapple>.
Filter, match, and iterate over tagged files from grapple
<https://github.com/cbochs/grapple.nvim>.

**Defaults**

Expand All @@ -225,11 +232,11 @@ Filter, match, and iterate over tagged files from harpoon
**Content**


- **type**`"harpoon"`
- **buffer**the tags’s `bufnr`
- **cursor**the tags’s `row` and `col`
- **type**`"grapple"`
- **buffer**the file tags’s `bufnr`
- **cursor**the file tags’s `row` and `col`
- **select**uses `grappleselect`
- **key**the tags’s key
- **key**the file tags’s key

Examples ~

Expand All @@ -255,10 +262,10 @@ Filter, match, and iterate over marked files from harpoon


- **type**`"harpoon"`
- **buffer**the mark’s `bufnr`
- **cursor**the mark’s `row` and `col`
- **buffer**the file mark’s `bufnr`
- **cursor**the file mark’s `row` and `col`
- **select**uses `harpoon.uinav_file`
- **index**the mark’s index
- **index**the file mark’s index

Examples ~

Expand Down

0 comments on commit 2625f35

Please sign in to comment.