Commit graph

68 commits

Author SHA1 Message Date
Noor
2ab82a4e88
docs(mini): update URLs for nvim-mini related plugins (#2189)
## Description

All plugins related to the mini.nvim project has been relocated to a
GitHub organization, as announced here:

https://github.com/nvim-mini/mini.nvim/discussions/1970

This commit updates all related URL:s in the documentation to refer to
the repositories for each plugin at the new organization.

## Related Issue(s)

N/A

## Screenshots

N/A
2025-09-17 15:36:48 +02:00
folke
a4d320f333 chore(build): auto-generate docs 2025-09-16 13:32:52 +00:00
folke
0d3bb4213f chore(build): auto-generate docs 2025-02-17 16:19:00 +00:00
folke
f346d297dd chore(build): auto-generate docs 2025-02-17 15:10:45 +00:00
Folke Lemaitre
bdb489bc60
docs: docgen 2025-02-13 18:04:04 +01:00
folke
9242a9bed8 chore(build): auto-generate docs 2025-02-12 08:26:58 +00:00
Folke Lemaitre
4e4e63048e
feat: added new image snacks plugin for the kitty graphics protocol 2025-02-09 22:35:13 +01:00
folke
7904aed195 chore(build): auto-generate docs 2025-02-06 08:39:20 +00:00
Folke Lemaitre
b77f63ec55
docs: remove hl groups and show message about using highlights picker instead to see them all 2025-02-06 09:38:15 +01:00
Folke Lemaitre
db92afbbb6
docs: docgen 2025-02-05 08:00:35 +01:00
Folke Lemaitre
766fb20bd5
ci: added picker example config to readme 2025-02-05 07:55:00 +01:00
Folke Lemaitre
17bdd182f7
docs: docgen 2025-01-31 08:32:20 +01:00
folke
da5edaf9d6 chore(build): auto-generate docs 2025-01-23 19:54:16 +00:00
Folke Lemaitre
ccc27521b8
docs: added picker to config section 2025-01-23 20:53:19 +01:00
Folke Lemaitre
559d6c6bf2
feat(snacks): added snacks.picker (#445)
## Description

More info coming tomorrow.

In short:
- very fast. pretty much realtime filtering/sorting in huge repos (like
1.7 million files)
- extensible
- easy to customize the layout (and lots of presets) with
`snacks.layout`
- simple to create custom pickers
- `vim.ui.select`
- lots of builtin pickers
- uses treesitter highlighting wherever it makes sense
- fast lua fuzzy matcher which supports the [fzf
syntax](https://junegunn.github.io/fzf/search-syntax/) and additionally
supports field filters, like `file:lua$ 'function`

There's no snacks picker command, just use lua.

```lua
-- all pickers
Snacks.picker()

-- run files picker
Snacks.picker.files(opts)
Snacks.picker.pick("files", opts)
Snacks.picker.pick({source = "files", ...})
```

<!-- Describe the big picture of your changes to communicate to the
maintainers
  why we should accept this pull request. -->

## Todo
- [x] issue with preview loc not always correct when scrolling fast in
list (probably due to `snacks.scroll`)
- [x] `grep` (`live_grep`) is sometimes too fast in large repos and can
impact ui rendering. Not very noticeable, but something I want to look
at.
- [x] docs
- [x] treesitter highlights are broken. Messed something up somewhere

## Related Issue(s)

<!--
  If this PR fixes any issues, please link to the issue here.
  - Fixes #<issue_number>
-->

## Screenshots

<!-- Add screenshots of the changes if applicable. -->
2025-01-14 22:53:59 +01:00
folke
ff803a60b3 chore(build): auto-generate docs 2024-12-16 10:28:02 +00:00
Folke Lemaitre
05602b6caf
docs: added documentation on how to customize styles 2024-12-15 11:17:32 +01:00
Folke Lemaitre
2a664b615f
ci: try making config options optional 2024-12-13 15:58:54 +01:00
Folke Lemaitre
b72560fa58
docs: docgen 2024-12-11 22:18:44 +01:00
Folke Lemaitre
8faafb3483
feat(scope): text objects and jumping for scopes. Closes #231 2024-12-11 22:17:59 +01:00
Odilf
ca736aecb2
docs(readme): fix typos (#232)
## Description

Just a couple of small typos. 

They're in highlighted blocks, so I figured it's worth it to make a PR
^^

Cool plugin!

## Related Issue(s)

N/A

## Screenshots

N/A
2024-12-10 16:55:05 +01:00
Folke Lemaitre
61439cab2f
docs: added new plugins to readme install/example section 2024-12-10 15:22:39 +01:00
folke
d7a3401662 chore(build): auto-generate docs 2024-12-10 13:27:29 +00:00
Folke Lemaitre
6ca848766c ci: docgen 2024-12-10 13:55:51 +01:00
Folke Lemaitre
a3c6ab23a0 docs: docgen 2024-12-10 13:55:51 +01:00
Folke Lemaitre
f68768fb13
docs(profiler): added screenshots 2024-12-01 14:40:58 +01:00
Folke Lemaitre
0b6be55eb8
docs: added profiler to readme 2024-12-01 13:37:20 +01:00
Folke Lemaitre
462e92d880
docs: added scratch to list of plugins 2024-12-01 09:12:05 +01:00
Folke Lemaitre
7c29848e89
feat(util): simple function to get an icon 2024-12-01 09:06:52 +01:00
Folke Lemaitre
d730a13b55
feat(config): allow overriding resolved options for a plugin. See #164 2024-11-27 21:43:15 +01:00
Scott McKendry
20f40627df
docs(dashboard): add highlight groups to readme (#113) 2024-11-20 09:52:40 +01:00
Folke Lemaitre
d540fa607c
feat(dashboard): added new dashboard snack (#77)
## Description

A new dashboard plugin that comes with sane defaults, and can be fully
customized to your liking.

## Screenshots


![image](https://github.com/user-attachments/assets/944373ea-f443-4c16-bfe0-2dc78101f8f5)


![image](https://github.com/user-attachments/assets/492b075e-168d-4d58-af39-1268c047f374)


![image](https://github.com/user-attachments/assets/53a388c2-ca5a-4efb-94f2-752222f43584)


![image](https://github.com/user-attachments/assets/3c6ee94b-6785-4035-8ed2-2f67f39b5f06)


![image](https://github.com/user-attachments/assets/5b7a7117-e504-4b36-88db-91ccc89d8997)
2024-11-18 16:25:17 +01:00
folke
971cb237b9 chore(build): auto-generate docs 2024-11-16 06:05:36 +00:00
nikeedev
dc0f4041dc
fix(docs): typo in README.md (#78)
Updated it because somebody place ! outside of the brackets :))

## Description

The big picture? Well, people can get lost because what does ![tip] mean
compared to **<span style="background-color: green; border: 2px solid
lightgreen">Tip</span>**?

## Related Issue(s)

It doesn't seem that there are any...

## Screenshots

<!-- Add screenshots of the changes if applicable. -->
2024-11-16 07:04:53 +01:00
Folke Lemaitre
7434770804 docs: docgen 2024-11-14 23:56:37 +01:00
Folke Lemaitre
1c4c74828f feat(health): added health checks to plugins 2024-11-14 23:56:37 +01:00
Folke Lemaitre
33ba45c540
docs: fix terminal example 2024-11-10 08:03:35 +01:00
folke
8a1d11ad08 chore(build): auto-generate docs 2024-11-09 14:45:21 +00:00
Jonáš Dujava
80927949f3
docs(example): fix rename file keymap (#47)
## Description

Fixes "Rename File" keymap in Usage section of README.

Signed-off-by: Jonas Dujava <jonas.dujava@gmail.com>
2024-11-09 15:44:37 +01:00
Teppei Taguchi
59ae7cf162
docs(readme, lazygit): fix typos (#16)
## Description

<!-- Describe the big picture of your changes to communicate to the
maintainers
  why we should accept this pull request. -->
Fixes minor typos in documentation.

## Related Issue(s)

<!--
  If this PR fixes any issues, please link to the issue here.
  - Fixes #<issue_number>
-->

## Screenshots

<!-- Add screenshots of the changes if applicable. -->
2024-11-07 13:50:13 +01:00
Iordanis Petkakis
964cd6aa76
feat(docs): docs for highlight groups (#13)
## Description
Docs for highlight groups. This is my first time dealing with tables in
Markdown. Hope I didn't mess anything up 😛
<!-- Describe the big picture of your changes to communicate to the
maintainers
  why we should accept this pull request. -->

## Related Issue(s)
Closes #8.
<!--
  If this PR fixes any issues, please link to the issue here.
  - Fixes #<issue_number>
-->

## Screenshots

<!-- Add screenshots of the changes if applicable. -->
2024-11-07 11:56:43 +01:00
Folke Lemaitre
650ae33e71
docs: typo example. Closes #3 2024-11-06 22:37:48 +01:00
Folke Lemaitre
318f70a958
docs: readme 2024-11-06 19:20:11 +01:00
Folke Lemaitre
a5a2d16390
docs: updated example 2024-11-06 18:59:14 +01:00
Folke Lemaitre
36e2d192c3
docs: docgen 2024-11-06 13:08:09 +01:00
Folke Lemaitre
910ce8f394
refactor: Snacks.rename.rename() => Snacks.rename.rename_file() 2024-11-06 12:21:31 +01:00
Folke Lemaitre
c834e0a326
docs: better readme 2024-11-06 11:13:32 +01:00
Folke Lemaitre
0ae7da85ae
docs: docgen for styles 2024-11-06 10:56:23 +01:00
Folke Lemaitre
796d235771
docs: docgen 2024-11-06 00:39:27 +01:00
Folke Lemaitre
c71f3c84f4
docs: update 2024-11-06 00:35:44 +01:00