Skip to content

Commit 470e033

Browse files
wsdjegwsdjeg
committed
docs(help): format help file
1 parent 2e7dc88 commit 470e033

1 file changed

Lines changed: 52 additions & 52 deletions

File tree

‎doc/picker.txt‎

Lines changed: 52 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
*picker.nvim* A Fuzzy Finder For Neovim Written In Lua
1+
*picker.nvim* A fuzzy finder for neovim written in lua
22

33
Author: Eric Wong <wsdjeg@outlook.com>
44
Url: https://github.com/wsdjeg/picker.nvim
55

66
==============================================================================
7-
CONTENTS *picker*
7+
CONTENTS *picker*
88

99
1. Introduction |picker-introduction|
1010
2. Features |picker-features|
@@ -46,7 +46,7 @@ CONTENTS *picker*
4646
14. License |picker-license|
4747

4848
==============================================================================
49-
1. INTRODUCTION *picker-introduction*
49+
1. INTRODUCTION *picker-introduction*
5050

5151
`picker.nvim` is a lightweight, high-performance fuzzy finder for Neovim,
5252
built around a simple and extensible design. It provides a fast fzy-based
@@ -56,7 +56,7 @@ symbols, diagnostics, or fully custom workflows, `picker.nvim` offers a clean
5656
and composable approach without the overhead of larger frameworks.
5757

5858
==============================================================================
59-
2. Features *picker-features*
59+
2. Features *picker-features*
6060

6161
- ⚡ High-performance fuzzy matching powered by the fzy algorithm
6262
- 🔧 Simple yet extensible source API
@@ -67,7 +67,7 @@ and composable approach without the overhead of larger frameworks.
6767
- 🔍 Live preview and asynchronous loading support
6868

6969
==============================================================================
70-
3. Installation *picker-installation*
70+
3. Installation *picker-installation*
7171

7272

7373
picker.nvim works with all major Neovim plugin managers.
@@ -168,10 +168,10 @@ Using luarocks <https://luarocks.org/>
168168
<
169169

170170
==============================================================================
171-
5. Basic Usage *picker-usage*
171+
5. Basic Usage *picker-usage*
172172

173173
------------------------------------------------------------------------------
174-
5.1 Picker Command *picker-command*
174+
5.1 Picker Command *picker-command*
175175

176176
fuzzy finder picker source.
177177

@@ -203,7 +203,7 @@ Using luarocks <https://luarocks.org/>
203203
<
204204

205205
------------------------------------------------------------------------------
206-
5.2 Key Bindings *picker-keybindings*
206+
5.2 Key Bindings *picker-keybindings*
207207

208208
In picker prompt window, the these mappings are defined by default.
209209

@@ -215,7 +215,7 @@ Using luarocks <https://luarocks.org/>
215215
| Esc | close picker |
216216

217217
==============================================================================
218-
6. Builtin Sources *picker-sources*
218+
6. Builtin Sources *picker-sources*
219219

220220
| source | description |
221221
| --------------------- | --------------------------------------- |
@@ -241,7 +241,7 @@ Using luarocks <https://luarocks.org/>
241241
| key-mappings | key mappings |
242242

243243
------------------------------------------------------------------------------
244-
6.1 files *picker-source-files*
244+
6.1 files *picker-source-files*
245245

246246
The default commands for listing files is `{'rg', '--files'}`.
247247
this can be changed via:
@@ -255,7 +255,7 @@ Using luarocks <https://luarocks.org/>
255255
| `<C-t>` | open select file in new tabpage |
256256

257257
------------------------------------------------------------------------------
258-
6.2 cmd_history *picker-source-cmd_history*
258+
6.2 cmd_history *picker-source-cmd_history*
259259

260260
filter results from `:history cmd`.
261261

@@ -265,7 +265,7 @@ Using luarocks <https://luarocks.org/>
265265
| `<C-d>` | delete select command history |
266266

267267
------------------------------------------------------------------------------
268-
6.3 search_history *picker-source-search_history*
268+
6.3 search_history *picker-source-search_history*
269269

270270
filter results from `:history search`.
271271

@@ -274,7 +274,7 @@ Using luarocks <https://luarocks.org/>
274274
| `<Enter>` | search selected pattern |
275275

276276
------------------------------------------------------------------------------
277-
6.4 picker_config *picker-source-picker_config*
277+
6.4 picker_config *picker-source-picker_config*
278278

279279
filter and setup picker.nvim without changing configuration file.
280280

@@ -292,7 +292,7 @@ Using luarocks <https://luarocks.org/>
292292
| `<Enter>` | set selected picker config |
293293

294294
------------------------------------------------------------------------------
295-
6.5 highlights *picker-source-highlights*
295+
6.5 highlights *picker-source-highlights*
296296

297297
filter results from `:highlight`
298298

@@ -301,7 +301,7 @@ Using luarocks <https://luarocks.org/>
301301
| `<Enter>` | yank selected highlight group name |
302302

303303
------------------------------------------------------------------------------
304-
6.6 async_files *picker-source-async_files*
304+
6.6 async_files *picker-source-async_files*
305305

306306
same as `files` source, but require job.nvim.
307307

@@ -310,7 +310,7 @@ Using luarocks <https://luarocks.org/>
310310
| `<Enter>` | open select file |
311311

312312
------------------------------------------------------------------------------
313-
6.7 colorscheme *picker-source-colorscheme*
313+
6.7 colorscheme *picker-source-colorscheme*
314314

315315
filter colorschemes.
316316

@@ -319,7 +319,7 @@ filter colorschemes.
319319
| `<Enter>` | change to selected colorscheme |
320320

321321
------------------------------------------------------------------------------
322-
6.8 buftags *picker-source-buftags*
322+
6.8 buftags *picker-source-buftags*
323323

324324
filter ctags outline, require ctags command.
325325

@@ -328,7 +328,7 @@ filter colorschemes.
328328
| `<Enter>` | jump to select tag |
329329

330330
------------------------------------------------------------------------------
331-
6.9 buffers *picker-source-buffers*
331+
6.9 buffers *picker-source-buffers*
332332

333333
file results from `nvim_list_bufs()`
334334

@@ -337,91 +337,91 @@ filter colorschemes.
337337
| `<Enter>` | switch to select buffer |
338338

339339
------------------------------------------------------------------------------
340-
6.10 lines *picker-source-lines*
340+
6.10 lines *picker-source-lines*
341341

342342
| key binding | description |
343343
| ----------- | --------------------- |
344344
| `<Enter>` | jump to selected line |
345345

346346
------------------------------------------------------------------------------
347-
6.11 help_tags *picker-source-help_tags*
347+
6.11 help_tags *picker-source-help_tags*
348348

349349
| key binding | description |
350350
| ----------- | ---------------------- |
351351
| `<Enter>` | jump selected help tag |
352352

353353
------------------------------------------------------------------------------
354-
6.12 qflist *picker-source-qflist*
354+
6.12 qflist *picker-source-qflist*
355355

356356
| key binding | description |
357357
| ----------- | -------------------------------- |
358358
| `<Enter>` | jump selected quickfix list item |
359359

360360
------------------------------------------------------------------------------
361-
6.13 loclist *picker-source-loclist*
361+
6.13 loclist *picker-source-loclist*
362362

363363
| key binding | description |
364364
| ----------- | -------------------------- |
365365
| `<Enter>` | jump selected loclist item |
366366

367367
------------------------------------------------------------------------------
368-
6.14 registers *picker-source-registers*
368+
6.14 registers *picker-source-registers*
369369

370370
| key binding | description |
371371
| ----------- | ---------------------- |
372372
| `<Enter>` | paste selected context |
373373

374374
------------------------------------------------------------------------------
375-
6.15 jumps *picker-source-jumps*
375+
6.15 jumps *picker-source-jumps*
376376

377377
| key binding | description |
378378
| ----------- | ---------------------- |
379379
| `<Enter>` | jump selected position |
380380

381381
------------------------------------------------------------------------------
382-
6.16 tags *picker-source-tags*
382+
6.16 tags *picker-source-tags*
383383

384384
| key binding | description |
385385
| ----------- | ---------------------- |
386386
| `<Enter>` | jump to selected tag |
387387

388388
------------------------------------------------------------------------------
389-
6.17 marks *picker-source-marks*
389+
6.17 marks *picker-source-marks*
390390

391391
| key binding | description |
392392
| ----------- | ---------------------- |
393393
| `<Enter>` | jump selected position |
394394

395395
------------------------------------------------------------------------------
396-
6.18 lsp_document_symbols *picker-source-lsp_document_symbols*
396+
6.18 lsp_document_symbols *picker-source-lsp_document_symbols*
397397

398398
| key binding | description |
399399
| ----------- | -------------------- |
400400
| `<Enter>` | jump selected symbol |
401401

402402
------------------------------------------------------------------------------
403-
6.19 lsp_workspace_symbols *picker-source-lsp_workspace_symbols*
403+
6.19 lsp_workspace_symbols *picker-source-lsp_workspace_symbols*
404404

405405
| key binding | description |
406406
| ----------- | -------------------- |
407407
| `<Enter>` | jump selected symbol |
408408

409409
------------------------------------------------------------------------------
410-
6.20 lsp_references *picker-source-lsp_references*
410+
6.20 lsp_references *picker-source-lsp_references*
411411

412412
| key binding | description |
413413
| ----------- | ----------------------- |
414414
| `<Enter>` | jump selected reference |
415415

416416
------------------------------------------------------------------------------
417-
6.21 lsp_definitions *picker-source-lsp_definitions*
417+
6.21 lsp_definitions *picker-source-lsp_definitions*
418418

419419
| key binding | description |
420420
| ----------- | --------------------------- |
421421
| `<Enter>` | jump to selected definition |
422422

423423
------------------------------------------------------------------------------
424-
6.22 emoji *picker-source-emoji*
424+
6.22 emoji *picker-source-emoji*
425425

426426
filter emoji entries from muan/unicode-emoji-json:
427427
https://github.com/muan/unicode-emoji-json
@@ -434,29 +434,29 @@ is not installed, `vim.fn.system()` will be used.
434434
| `<Enter>` | insert selected emoji |
435435

436436
------------------------------------------------------------------------------
437-
6.23 key-mappings *picker-source-key-mappings*
437+
6.23 key-mappings *picker-source-key-mappings*
438438

439439
| key binding | description |
440440
| ----------- | ---------------------------- |
441441
| `<Enter>` | trigger selected key mapping |
442442

443443
==============================================================================
444-
7. Third party sources *picker-third-party-sources*
445-
446-
| source | description |
447-
| ----------------- | ------------------------------------------------------ |
448-
| mru | most recent used files, need `wsdjeg/mru.nvim` |
449-
| project | project history, need `wsdjeg/rooter.nvim` |
450-
| bookmarks | all bookmarks, need `wsdjeg/bookmarks.nvim` |
451-
| zettelkasten | zk notes source from `wsdjeg/zettelkasten.nvim` |
452-
| zettelkasten_tags | zk tags source from `wsdjeg/zettelkasten.nvim` |
453-
| git-branch | git branch source from `wsdjeg/git.nvim` |
454-
| music-player | music-player source form `wsdjeg/music-player.nvim` |
455-
| plug | plugins source for `wsdjeg/nvim-plug` |
456-
| async_files | async files source, require `wsdjeg/job.nvim` |
444+
7. Third party sources *picker-third-party-sources*
445+
446+
| source | description |
447+
| ----------------- | ---------------------------------------------------- |
448+
| mru | most recent used files, need `wsdjeg/mru.nvim` |
449+
| project | project history, need `wsdjeg/rooter.nvim` |
450+
| bookmarks | all bookmarks, need `wsdjeg/bookmarks.nvim` |
451+
| zettelkasten | zk notes source from `wsdjeg/zettelkasten.nvim` |
452+
| zettelkasten_tags | zk tags source from `wsdjeg/zettelkasten.nvim` |
453+
| git-branch | git branch source from `wsdjeg/git.nvim` |
454+
| music-player | music-player source form `wsdjeg/music-player.nvim` |
455+
| plug | plugins source for `wsdjeg/nvim-plug` |
456+
| async_files | async files source, require `wsdjeg/job.nvim` |
457457

458458
==============================================================================
459-
8. Custom source *picker-custom-source*
459+
8. Custom source *picker-custom-source*
460460

461461
a source main module should be `picker.sources.<name>`,
462462
that means you can create a custom source in `lua/picker/sources/`
@@ -491,7 +491,7 @@ require('picker.windows').open(custom_source, {})
491491
<
492492

493493
==============================================================================
494-
9. Custom layout *picker-custom-layout*
494+
9. Custom layout *picker-custom-layout*
495495

496496
picker.nvim use `default` layout by default. a layout should provide
497497
following public functions:
@@ -517,7 +517,7 @@ following public functions:
517517
<
518518

519519
==============================================================================
520-
10. FAQ *picker-faq*
520+
10. FAQ *picker-faq*
521521

522522
1. how to disable nvim-cmp in picker.nvim buffer?
523523

@@ -575,7 +575,7 @@ following public functions:
575575
<
576576

577577
==============================================================================
578-
11. Self-Promotion *picker-self-promotion*
578+
11. Self-Promotion *picker-self-promotion*
579579

580580
Like this plugin? Star the repository on
581581
GitHub.
@@ -584,19 +584,19 @@ Love this plugin? Follow [me](https://wsdjeg.net/) on
584584
[GitHub](https://github.com/wsdjeg).
585585

586586
==============================================================================
587-
12. Feedback *picker-feedback*
587+
12. Feedback *picker-feedback*
588588

589589
If you encounter any bugs or have suggestions, please file an issue in the
590590
issue tracker: https://github.com/wsdjeg/picker.nvim/issues
591591

592592
==============================================================================
593-
13. Credits *picker-credits*
593+
13. Credits *picker-credits*
594594

595595
- [telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)
596596
- [denite.nvim](https://github.com/Shougo/denite.nvim)
597597

598598
==============================================================================
599-
14. License *picker-license*
599+
14. License *picker-license*
600600

601601
Licensed under GPL-3.0.
602602

0 commit comments

Comments
 (0)