summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDave Lage <rockerboo@gmail.com>2020-12-10 18:37:17 -0500
committerGitHub <noreply@github.com>2020-12-10 18:37:17 -0500
commitb4b4c7652d1f0df58d667c87e97c9a83a86d420a (patch)
tree7623d6bb9b597e654b3dcacfada02544d2f4d5c6 /README.md
parent3a416f552b34cf54659c316f3f99e625ff9d3aa2 (diff)
Make smaller targetable lists for pickers
Diffstat (limited to 'README.md')
-rw-r--r--README.md59
1 files changed, 44 insertions, 15 deletions
diff --git a/README.md b/README.md
index 1236d77..771a02b 100644
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@ Gaze deeply into unknown regions using the power of the moon.
## What Is Telescope?
`telescope.nvim` is a highly extendable fuzzy finder over lists. Built on the latest
-awesome features from `neovim` core. Telescope is centered around
+awesome features from `neovim` core. Telescope is centered around
modularity, allowing for easy customization.
Community driven built-in [pickers](#pickers), [sorters](#sorters) and [previewers](#previewers).
@@ -355,12 +355,20 @@ require('telescope.builtin').fd({ -- or new custom picker's attach_mappings fiel
Built-in function ready to be bound to any key you like :smile:.
+### Files
+
| Functions | Description |
|-------------------------------------|---------------------------------------------------------------------------------------------|
-| `builtin.planets` | Demo showcasing how simple to create pickers with telescope. |
-| `builtin.builtin` | Lists Built-in pickers and run them on enter. |
| `builtin.find_files` | Lists Files in current directory. |
| `builtin.git_files` | Lists Git files in current directory. |
+| `builtin.grep_string` | Searches for a string under the cursor in current directory. |
+| `builtin.live_grep` | Searches in current directory files. (respecting .gitignore) |
+|-------------------------------------|---------------------------------------------------------------------------------------------|
+
+### Vim
+
+| Functions | Description |
+|-------------------------------------|---------------------------------------------------------------------------------------------|
| `builtin.buffers` | Lists Open buffers in the current vim instance. |
| `builtin.oldfiles` | Lists Previously open files. |
| `builtin.commands` | Lists Available plugin/user commands and run it. |
@@ -370,31 +378,52 @@ Built-in function ready to be bound to any key you like :smile:.
| `builtin.man_pages` | Lists Man entries. |
| `builtin.marks` | Lists Markers and their value. |
| `builtin.colorscheme` | Lists Colorscheme and switch to it on enter. |
-| `builtin.treesitter` | Lists Function names, variables, from Treesitter! |
-| `builtin.live_grep` | Searches in current directory files. (respecting .gitignore) |
-| `builtin.current_buffer_fuzzy_find` | Searches in current buffer lines. |
-| `builtin.current_buffer_tags` | Lists Tags in current buffer. |
-| `builtin.grep_string` | Searches for a string under the cursor in current directory. |
-| `builtin.lsp_references` | Searches in LSP references. |
-| `builtin.lsp_document_symbols` | Searches in LSP Document Symbols in the current document. |
-| `builtin.lsp_workspace_symbols` | Searches in LSP all workspace symbols. |
-| `builtin.lsp_code_actions` | Lists LSP action to be trigged on enter. |
-| `builtin.lsp_range_code_actions` | Lists LSP range code action to be trigged on enter. |
| `builtin.quickfix` | Lists items from quickfix. |
| `builtin.loclist` | Lists items from current window's location list. |
-| `builtin.reloader` | Lists lua modules and reload them on enter. |
| `builtin.vim_options` | Lists vim options and on enter edit the options value. |
| `builtin.registers` | Lists vim registers and edit or paste selection. |
| `builtin.autocommands` | Lists vim autocommands and go to their declaration. |
| `builtin.keymaps` | Lists normal-mode mappings. |
| `builtin.filetypes` | Lists all filetypes. |
| `builtin.highlights` | Lists all highlights. |
+| .................................. | Your next awesome picker function here :D |
+
+### LSP
+
+| Functions | Description |
+|-------------------------------------|---------------------------------------------------------------------------------------------|
+| `builtin.lsp_references` | Searches in LSP references. |
+| `builtin.lsp_document_symbols` | Searches in LSP Document Symbols in the current document. |
+| `builtin.lsp_workspace_symbols` | Searches in LSP all workspace symbols. |
+| `builtin.lsp_code_actions` | Lists LSP action to be trigged on enter. |
+| `builtin.lsp_range_code_actions` | Lists LSP range code action to be trigged on enter. |
+| .................................. | Your next awesome picker function here :D |
+
+### Git
+
+| Functions | Description |
+|-------------------------------------|---------------------------------------------------------------------------------------------|
| `builtin.git_commits` | Lists git commits with diff preview and on enter checkout the commit. |
| `builtin.git_bcommits` | Lists buffer's git commits with diff preview and checkouts it out on enter. |
| `builtin.git_branches` | Lists all branches with log preview and checkout action. |
| `builtin.git_status` | Lists current changes per file with diff preview and add action. (Multiselection still WIP) |
+| .................................. | Your next awesome picker function here :D |
+
+### Treesitter
+| `builtin.treesitter` | Lists Function names, variables, from Treesitter! |
+| .................................. | Your next awesome picker function here :D |
+
+### Lists
+
+| Functions | Description |
+|-------------------------------------|---------------------------------------------------------------------------------------------|
+| `builtin.planets` | Use the telescope. |
+| `builtin.builtin` | Lists Built-in pickers and run them on enter. |
+| `builtin.current_buffer_fuzzy_find` | Searches in current buffer lines. |
+| `builtin.current_buffer_tags` | Lists Tags in current buffer. |
+| `builtin.reloader` | Lists lua modules and reload them on enter. |
| `builtin.symbols` | Lists symbols inside a file `data/telescope-sources/*.json` found in your rtp. More info and symbol sources can be found [here](https://github.com/nvim-telescope/telescope-symbols.nvim) |
-| .................................. | Your next awesome finder function here :D |
+| .................................. | Your next awesome picker function here :D |
## Previewers