leigh/telescope.nvim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme: fix broken links and spelling errors (#753)

Browse Source
This commit is contained in:
Ben Smith
2021-04-13 18:59:10 +00:00
committed by GitHub
parent 253d3aaa6b
commit b7d0488db9
1 changed files with 13 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -40,7 +40,7 @@ Community driven built-in [pickers](#pickers), [sorters](#sorters) and [previewe
- [Gallery](https://github.com/nvim-telescope/telescope.nvim/wiki/Gallery) - [Gallery](https://github.com/nvim-telescope/telescope.nvim/wiki/Gallery)
- [FAQ](#faq) - [FAQ](#faq)
- [Configuration recipes](https://github.com/nvim-telescope/telescope.nvim/wiki/Configuration-Recipes) - [Configuration recipes](https://github.com/nvim-telescope/telescope.nvim/wiki/Configuration-Recipes)
- [Contributing](#contribution) - [Contributing](#contributing)
## Getting Started ## Getting Started
@@ -113,7 +113,7 @@ This section should help you explore available options to configure and
customize your `telescope.nvim`. customize your `telescope.nvim`.
Unlike most vim plugins, `telescope.nvim` can be customized either by applying Unlike most vim plugins, `telescope.nvim` can be customized either by applying
customizations globally or individual pre picker. customizations globally or individual per picker.
- **Global Customization** affecting all pickers can be done through the - **Global Customization** affecting all pickers can be done through the
main `setup()` method (see defaults below) main `setup()` method (see defaults below)
@@ -190,7 +190,7 @@ require('telescope').setup{
EOF EOF
``` ```
<!-- TODO: move some options to Options affecting Behaviour --> <!-- TODO: move some options to Options affecting behavior -->
### Options affecting Presentation ### Options affecting Presentation
@@ -419,7 +419,7 @@ Built-in functions. Ready to be bound to any key you like. :smile:
| `builtin.git_commits` | Lists git commits with diff preview and on enter checkout the commit. | | `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_bcommits` | Lists buffer's git commits with diff preview and checkouts it out on enter. |
| `builtin.git_branches` | Lists all branches with log preview, checkout action (<cr>), track action (<c-t>) and rebase action(<c-r>). | | `builtin.git_branches` | Lists all branches with log preview, checkout action (<cr>), track action (<c-t>) and rebase action(<c-r>). |
| `builtin.git_status` | Lists current changes per file with diff preview and add action. (Multiselection still WIP) | | `builtin.git_status` | Lists current changes per file with diff preview and add action. (Multi-selection still WIP) |
### Treesitter Picker ### Treesitter Picker
@@ -472,7 +472,7 @@ autocmd User TelescopePreviewerLoaded setlocal wrap
| `sorters.fuzzy_with_index_bias` | Used to list stuff with consideration to when the item is added | | `sorters.fuzzy_with_index_bias` | Used to list stuff with consideration to when the item is added |
A `Sorter` is called by the `Picker` on each item returned by the `Finder`. It A `Sorter` is called by the `Picker` on each item returned by the `Finder`. It
return a number, which is equivalent to the "distance" between the current returns a number, which is equivalent to the "distance" between the current
`prompt` and the `entry` returned by a `finder`. `prompt` and the `entry` returned by a `finder`.
<!-- TODO review --> <!-- TODO review -->
@@ -511,15 +511,15 @@ make a theme, check out `lua/telescope/themes.lua`.
Telescope user autocmds: Telescope user autocmds:
| Event | Description | | Event | Description |
|---------------------------------|----------------------------------------------------| |---------------------------------|---------------------------------------------------------|
| `User TelescopeFindPre` | Do it before create Telescope all the float window | | `User TelescopeFindPre` | Do it before Telescope creates all the floating windows |
| `User TelescopePreviewerLoaded` | Do it after Telescope previewer window create | | `User TelescopePreviewerLoaded` | Do it after Telescope previewer window is created |
## Extensions ## Extensions
Telescope provides the capabilties to create & register extensions, which improve telescope in a variety of ways. Telescope provides the capabilities to create & register extensions, which improve telescope in a variety of ways.
Some extensions provide integration with external tools, outside of the scope of `builtins`. Others provide performance Some extensions provide integration with external tools, outside of the scope of `builtins`. Others provide performance
enhancements by using compiled C and interfacing directly with Lua. enhancements by using compiled C and interfacing directly with Lua.
@@ -669,9 +669,8 @@ supports tab completions and settings options.
### How to change some defaults in built-in functions? ### How to change some defaults in built-in functions?
All options available from the setup function (see [Configuration options]()) and All options available from the setup function (see [Configuration options](#customization)
some other functions can be easily changed in custom pickers or built-in and some other functions can be easily changed in custom pickers or built-in functions.
functions.
<!-- TODO: insert a list of available options like previewer and prompt prefix --> <!-- TODO: insert a list of available options like previewer and prompt prefix -->
```lua ```lua
@@ -685,7 +684,7 @@ nnoremap <leader>fg :Telescope live_grep prompt_prefix=🔍<CR>
### How to change Telescope Highlights group? ### How to change Telescope Highlights group?
There are 10 highlights group you can play around with in order to meet your needs: There are 10 highlight groups you can play around with in order to meet your needs:
```viml ```viml
highlight TelescopeSelection guifg=#D79921 gui=bold " selected item highlight TelescopeSelection guifg=#D79921 gui=bold " selected item