docs: add some features images

This commit is contained in:
tomasky 2022-07-05 18:27:27 +08:00
parent 23e31a83fc
commit e502d33bf8

View File

@ -2,6 +2,14 @@
A Bookmarks Plugin With Global File Store For Neovim Written In Lua.
## Features
- Display different icons according to annotation keywords
![](http://raw.github.com/tomasky/tomasky/main/bookmarksfeatures2.png)
- open bookmarks in a quickfix list
- search marks with Telescope
![](http://raw.github.com/tomasky/tomasky/main/bookmarksfeatures1.png)
## Requirements
- Neovim >= 0.7.0
@ -37,16 +45,16 @@ Here is an example with most of the default settings:
require('bookmarks').setup {
save_file = vim.fn.expand "$HOME/.bookmarks", -- bookmarks save file path
keywords = {
["@t"] = "☑️ ", -- mark annotation startswith @t ,signs this icon of todo
["@w"] = "⚠️ ", -- mark annotation startswith @w ,signs this icon of warn
["@f"] = "⛏ ", -- mark annotation startswith @f ,signs this icon of fix
["@n"] = " ", -- mark annotation startswith @n ,signs this icon of note
["@t"] = "☑️ ", -- mark annotation startswith @t ,signs this icon as `Todo`
["@w"] = "⚠️ ", -- mark annotation startswith @w ,signs this icon as `Warn`
["@f"] = "⛏ ", -- mark annotation startswith @f ,signs this icon as `Fix`
["@n"] = " ", -- mark annotation startswith @n ,signs this icon as `Note`
},
on_attach = function(bufnr)
local bm = require "bookmarks"
local map = vim.keymap.set
map("n","mm",bm.bookmark_toggle) -- add or remove bookmark at current line
map("n","mi",bm.bookmark_ann) -- add mark annotation at current line
map("n","mi",bm.bookmark_ann) -- add or edit mark annotation at current line
map("n","mc",bm.bookmark_clean) -- clean all marks in local buffer
map("n","mn",bm.bookmark_next) -- jump to next mark in local buffer
map("n","mp",bm.bookmark_prev) -- jump to previous mark in local buffer