You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-56Lines changed: 20 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,18 +10,15 @@
10
10
11
11
## Why?
12
12
13
-
Vim's built-in marks are great, but they're global and get messy fast. Marksman keeps your bookmarks organized by project, adds powerful search capabilities, and provides a clean interface to manage them with modern features like undo support and mark descriptions.
13
+
Vim's built-in marks are great, but they're global and get messy fast. Marksman keeps your bookmarks organized by project, adds powerful search capabilities, and provides a clean interface to manage them with modern features like smart naming and file path display.
14
14
15
15
## Features
16
16
17
17
-**Project-scoped marks** - Each project gets its own isolated set of bookmarks
18
18
-**Persistent storage** - Your marks survive Neovim restarts with automatic backup
19
19
-**Smart naming** - Context-aware auto-generation of mark names based on code structure
20
20
-**Quick access** - Jump to your most recent marks with single keys
21
-
-**Enhanced search** - Find marks by name, description, file path, or content
22
-
-**Mark descriptions** - Add context and notes to your bookmarks
23
-
-**Undo support** - Restore accidentally deleted marks
24
-
-**Statistics** - View detailed analytics about your mark usage
21
+
-**Enhanced search** - Find marks by name, file path, or content
25
22
-**Validation** - Check and clean up marks pointing to non-existent files
26
23
-**Interactive UI** - Browse and manage marks in an enhanced floating window
27
24
-**Multiple integrations** - Works with Telescope, Snacks.nvim, and more
@@ -57,9 +54,7 @@ Vim's built-in marks are great, but they're global and get messy fast. Marksman
57
54
},
58
55
auto_save=true,
59
56
max_marks=100,
60
-
enable_descriptions=true,
61
57
search_in_ui=true,
62
-
undo_levels=10,
63
58
sort_marks=true,
64
59
silence=false,
65
60
minimal=false,
@@ -83,8 +78,6 @@ require("marksman").setup({
83
78
},
84
79
auto_save=true,
85
80
max_marks=100,
86
-
enable_descriptions=true,
87
-
undo_levels=10,
88
81
})
89
82
```
90
83
@@ -132,57 +125,39 @@ require("marksman").setup({
132
125
- Press Enter or 1-9 to jump
133
126
-`d` to delete
134
127
-`r` to rename
135
-
-`e` to edit description
136
128
-`/` to search
137
-
-`u` to undo last deletion
138
129
-`v` to validate marks
139
-
-`s` to show statistics
140
130
141
131
### Advanced Features
142
132
143
-
#### Mark Descriptions
144
-
Add context to your marks for better organization:
145
-
```lua
146
-
require("marksman").add_mark("api_endpoint", "Main API route handler")
marksman.goto_mark(1) -- Jump to first mark by index
319
287
marksman.delete_mark("my_mark")
320
288
marksman.rename_mark("old_name", "new_name")
321
289
322
290
-- Enhanced features
323
-
marksman.update_mark_description("my_mark", "New description")
324
291
marksman.search_marks("search query")
325
-
marksman.undo_last_deletion()
326
292
marksman.show_marks()
327
293
328
294
-- Utility functions
@@ -337,7 +303,6 @@ marksman.import_marks()
337
303
```lua
338
304
localstorage=require("marksman.storage")
339
305
340
-
storage.get_statistics() -- Get detailed analytics
341
306
storage.validate_marks() -- Check mark integrity
342
307
storage.get_project_name() -- Get current project name
343
308
```
@@ -349,12 +314,9 @@ storage.get_project_name() -- Get current project name
349
314
|`keymaps`| table |`{...}`| Key mappings for mark operations |
350
315
|`auto_save`| boolean |`true`| Automatically save marks |
351
316
|`max_marks`| number |`100`| Maximum marks per project |
352
-
|`enable_descriptions`| boolean |`true`| Enable mark descriptions |
353
317
|`search_in_ui`| boolean |`true`| Enable search in UI |
354
-
|`undo_levels`| number |`10`| Number of deletions to remember |
355
318
|`sort_marks`| boolean |`true`| Sort marks by access time (false = insertion order) |
356
-
|`sort_marks`| boolean |`true`| Sort marks by access time (false = insertion order) |
357
-
|`minimal`| boolean |`false`| Set to true for clean UI (only order and filename)|
319
+
|`minimal`| boolean |`false`| Set to true for clean UI (only order and filepath)|
358
320
|`highlights`| table |`{...}`| Custom highlight groups |
359
321
360
322
### Sorting Behavior
@@ -399,10 +361,12 @@ Marksman uses multiple methods to find your project root:
399
361
### Search Algorithm
400
362
The search function looks through:
401
363
- Mark names
402
-
- Mark descriptions
403
364
- File names and paths
404
365
- Code context (the line content)
405
366
367
+
### File Path Display
368
+
The UI now shows relative file paths instead of just filenames, making it easier to distinguish between files with the same name in different directories.
369
+
406
370
## Performance
407
371
408
372
-**Lazy loading**: Modules are only loaded when needed
0 commit comments