Skip to content

Commit ec47492

Browse files
committed
docs: fixed ProjectFzf docs and added for ProjectTelescope
Signed-off-by: Guennadi Maximov C <g.maxc.fox@protonmail.com>
1 parent 895e8d9 commit ec47492

2 files changed

Lines changed: 45 additions & 16 deletions

File tree

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,12 @@ Show these much love!
4848
1. [Telescope Mappings](#telescope-mappings)
4949
5. [Commands](#commands)
5050
1. [ProjectFzf](#projectfzf)
51-
1. [ProjectAdd](#projectadd)
52-
2. [ProjectRoot](#projectroot)
53-
3. [ProjectRecents](#projectrecents)
54-
4. [ProjectConfig](#projectconfig)
55-
5. [ProjectDelete](#projectdelete)
51+
2. [ProjectTelescope](#projecttelescope)
52+
3. [ProjectAdd](#projectadd)
53+
4. [ProjectRoot](#projectroot)
54+
5. [ProjectRecents](#projectrecents)
55+
6. [ProjectConfig](#projectconfig)
56+
7. [ProjectDelete](#projectdelete)
5657
6. [API](#api)
5758
1. [`run_fzf_lua()`](#run-fzf-lua)
5859
2. [`get_project_root()`](#get-project-root)
@@ -631,12 +632,19 @@ These are the user commands you can call from the cmdline:
631632

632633
### ProjectFzf
633634

634-
> This command is only enabled if you have `fzf-lua` installed
635+
> This command is only enabled if you have installed `fzf-lua`
635636
636637
The `:ProjectFzf` command is a dynamicly enabled User Command that runs
637638
`project.nvim` through `fzf-lua`.
638639
For now it just executes [`require('project').run_fzf_lua()`](#run-fzf-lua).
639640

641+
### ProjectTelescope
642+
643+
> This command is only enabled if you have `telescope.nvim` (and you loaded it)
644+
645+
The `:ProjectTelescope` command is a dynamicly enabled User Command that runs
646+
the Telescope `projects` picker. A shortcut, really.
647+
640648
### ProjectAdd
641649

642650
The `:ProjectAdd` command is a manual hook to add to session projects, then

doc/project-nvim.txt

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,13 @@ Table of Contents *project-nvim.toc*
3131
6. Telescope |project-nvim.telescope|
3232
6.1. Telescope Mappings |project-nvim.telescope.maps|
3333
7. Commands |project-nvim.commands|
34-
7.1. `:ProjectAdd` |:ProjectAdd|
35-
7.2. `:ProjectRoot` |:ProjectRoot|
36-
7.3. `:ProjectConfig` |:ProjectConfig|
37-
7.4. `:ProjectRecents` |:ProjectRecents|
38-
7.5. `:ProjectDelete` |:ProjectDelete|
34+
7.1. `:ProjectFzf` |:ProjectFzf|
35+
7.2. `:ProjectTelescope` |:ProjectTelescope|
36+
7.3. `:ProjectAdd` |:ProjectAdd|
37+
7.4. `:ProjectRoot` |:ProjectRoot|
38+
7.5. `:ProjectConfig` |:ProjectConfig|
39+
7.6. `:ProjectRecents` |:ProjectRecents|
40+
7.7. `:ProjectDelete` |:ProjectDelete|
3941
8. API |project-nvim.api|
4042
8.1. `get_project_root()` |project-nvim.get_project_root()|
4143
8.2. `get_recent_projects()` |project-nvim.get_recent_projects()|
@@ -520,16 +522,35 @@ Table of Contents *project-nvim.toc*
520522
7. Commands *project-nvim.commands*
521523

522524
There are a bunch of user commands you can call from the cmdline.
523-
Some of them might be incomplete and/or reworked in the future.
524525

526+
NOTE: Some of these might be incomplete and/or reworked in the future. ~
525527

528+
529+
*ProjectFzf* *:ProjectFzf*
526530
`:ProjectFzf`
527531

528-
This command is only enabled if you have `fzf-lua` installed ~
532+
This command is only enabled ~
533+
if you have `fzf-lua` installed ~
534+
535+
The `:ProjectFzf` command is a
536+
dynamicly enabled User Command that runs
537+
`project.nvim` through `fzf-lua`.
538+
For now it just executes
539+
`require('project').run_fzf_lua()`
540+
541+
542+
*ProjectTelescope* *:ProjectTelescope*
543+
`:ProjectTelescope`
544+
545+
This command is only enabled if you have ~
546+
both `telescope.nvim` and have loaded ~
547+
the `projects` picker ~
548+
(see |project-nvim.telescope|) ~
529549

530-
The `:ProjectFzf` command is a dynamicly enabled User Command that runs
531-
`project.nvim` through `fzf-lua`.
532-
For now it just executes `require('project').run_fzf_lua()`
550+
The `:ProjectTelescope` command is a
551+
dynamicly enabled User Command
552+
that runs the Telescope `projects` picker.
553+
A shortcut, really
533554

534555

535556
*ProjectAdd* *:ProjectAdd*

0 commit comments

Comments
 (0)