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

update

Browse Source
This commit is contained in:
Elflare
2025-07-05 20:14:55 +08:00
parent 0a312d5796
commit e0b96abe4f
2 changed files with 37 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
README.md
View File

@@ -1,7 +1,5 @@
# memos.nvim # memos.nvim
English | [简体中文](./README.md#memosnvim-简体中文) English | [简体中文](./README.md#memosnvim-简体中文)
A Neovim plugin to interact with [Memos](https://github.com/usememos/memos) right inside the editor. List, create, edit, and delete your memos without leaving Neovim. A Neovim plugin to interact with [Memos](https://github.com/usememos/memos) right inside the editor. List, create, edit, and delete your memos without leaving Neovim.
## ✨ Features ## ✨ Features
@@ -18,27 +16,7 @@ Requires [plenary.nvim](https://github.com/nvim-lua/plenary.nvim).
Install with [lazy.nvim](https://github.com/folke/lazy.nvim): Install with [lazy.nvim](https://github.com/folke/lazy.nvim):
```lua ```lua
-- lua/plugins/memos.lua { "Elflare/memos.nvim", dependencies = { "nvim-lua/plenary.nvim" } },
return {
"Elflare/memos.nvim",
dependencies = { "nvim-lua/plenary.nvim" },
config = function()
require("memos").setup({
host = "",
token = "",
pageSize = 50,
keymaps = {
list = {
add_memo = "a",
-- ... other list keymaps
},
buffer = {
save = "<leader>ms", -- Your desired save keymap
},
},
})
end,
}
``` ```
## 🚀 Usage ## 🚀 Usage
@@ -53,34 +31,35 @@ return {
#### Global #### Global
| Key | Action | | Key | Action |
| ------------------ | ------------------------------------ | | ------------ | ------------------- |
| `<leader>mm` | Open the Memos list | | `<leader>mm` | Open the Memos list |
#### In the Memo List Window #### In the Memo List Window
| Key | Action | | Key | Action |
| ------------------ | ------------------------------------ | | ----------- | ---------------------------------- |
| `a` | Add a new memo | | `a` | Add a new memo |
| `d` or `dd` | Delete the selected memo | | `d` or `dd` | Delete the selected memo |
| `<CR>` | Edit the selected memo | | `<CR>` | Edit the selected memo |
| `<Tab>` | Edit the selected memo in a vsplit | | `<Tab>` | Edit the selected memo in a vsplit |
| `s` | Search your memos | | `s` | Search your memos |
| `r` | Refresh the memo list | | `r` | Refresh the memo list |
| `.` | Load the next page of memos | | `.` | Load the next page of memos |
| `q` | Quit the list window | | `q` | Quit the list window |
#### In the Edit/Create Buffer #### In the Edit/Create Buffer
| Key | Action | | Key | Action |
| ------------------ | ------------------------------------ | | ------------ | --------------------- |
| `<leader>ms` | Save the current memo | | `<leader>ms` | Save the current memo |
## ⚙️ Configuration ## ⚙️ Configuration
You can override the default settings by passing a table to the `setup()` function. You can override the default settings by passing a table to the `setup()` function.
```lua ```lua
-- lua/plugins/memos.lua
require("memos").setup({ require("memos").setup({
-- REQUIRED: Your Memos host URL -- REQUIRED: Your Memos host URL
host = "https://your-memos-host.com", host = "https://your-memos-host.com",
@@ -138,27 +117,7 @@ require("memos").setup({
使用 [lazy.nvim](https://github.com/folke/lazy.nvim) 安装: 使用 [lazy.nvim](https://github.com/folke/lazy.nvim) 安装:
```lua ```lua
-- lua/plugins/memos.lua { "Elflare/memos.nvim", dependencies = { "nvim-lua/plenary.nvim" } },
return {
"Elflare/memos.nvim",
dependencies = { "nvim-lua/plenary.nvim" },
config = function()
require("memos").setup({
host = "",
token = "",
pageSize = 50,
keymaps = {
list = {
add_memo = "a",
-- ... 其他列表快捷键
},
buffer = {
save = "<leader>ms", -- 这是您想要的保存快捷键
},
},
})
end,
}
``` ```
## 🚀 使用方法 ## 🚀 使用方法
@@ -173,34 +132,35 @@ return {
#### 全局快捷键 #### 全局快捷键
| 按键 | 功能 | | 按键 | 功能 |
| ------------------ | ---------------------------------- | | ------------ | --------------- |
| `<leader>mm` | 打开 Memos 列表 | | `<leader>mm` | 打开 Memos 列表 |
#### 在 Memo 列表窗口中 #### 在 Memo 列表窗口中
| 按键 | 功能 | | 按键 | 功能 |
| ------------------ | ---------------------------------- | | ----------- | --------------------------- |
| `a` | 新增一个 memo | | `a` | 新增一个 memo |
| `d` 或 `dd` | 删除所选的 memo | | `d` 或 `dd` | 删除所选的 memo |
| `<CR>` | 编辑所选的 memo | | `<CR>` | 编辑所选的 memo |
| `<Tab>` | 在垂直分屏中编辑所选的 memo | | `<Tab>` | 在垂直分屏中编辑所选的 memo |
| `s` | 搜索你的 memos | | `s` | 搜索你的 memos |
| `r` | 刷新 memo 列表 | | `r` | 刷新 memo 列表 |
| `.` | 加载下一页 memos | | `.` | 加载下一页 memos |
| `q` | 退出列表窗口 | | `q` | 退出列表窗口 |
#### 在编辑/创建缓冲区中 #### 在编辑/创建缓冲区中
| 按键 | 功能 | | 按键 | 功能 |
| ------------------ | ---------------------------------- | | ------------ | ------------- |
| `<leader>ms` | 保存当前 memo | | `<leader>ms` | 保存当前 memo |
## ⚙️ 配置 ## ⚙️ 配置
你可以通过向 `setup()` 函数传递一个 table 来覆盖默认设置。 你可以通过向 `setup()` 函数传递一个 table 来覆盖默认设置。
```lua ```lua
-- lua/plugins/memos.lua
require("memos").setup({ require("memos").setup({
-- 必填: 你的 Memos 服务地址 -- 必填: 你的 Memos 服务地址
host = "https://your-memos-host.com", host = "https://your-memos-host.com",