docs: update README doc

This commit is contained in:
JuanZoran 2023-01-16 00:43:17 +08:00
parent 2c57923f6a
commit 0ca9710061
2 changed files with 37 additions and 27 deletions

View File

@ -1,4 +1,6 @@
# Trans.nvim # Trans.nvim
<!--toc:start-->
- [Trans.nvim](#transnvim) - [Trans.nvim](#transnvim)
- [特点](#特点) - [特点](#特点)
- [屏幕截图](#屏幕截图) - [屏幕截图](#屏幕截图)
@ -8,7 +10,8 @@
- [高亮组](#高亮组) - [高亮组](#高亮组)
- [声明](#声明) - [声明](#声明)
- [感谢](#感谢) - [感谢](#感谢)
- [TODO](#todo) - [TODO](#todo)
<!--toc:end-->
## 特点 ## 特点
@ -27,8 +30,9 @@
- 英文翻译 (不是英译中, 而是用英文解释) - 英文翻译 (不是英译中, 而是用英文解释)
- 词根 - 词根
- etc - etc
- 舒服的排版和`动画`
- 支持 `normal``visual`模式 - 支持 `normal``visual`模式
> 不支持 visual-block mode > 不支持 visual-block mode
- 本地词库单词量: `430w` - 本地词库单词量: `430w`
@ -63,11 +67,12 @@ use {
{ 'v', 'mm' }, -- 换成其他你想用的key即可 { 'v', 'mm' }, -- 换成其他你想用的key即可
{ 'n', 'mm' }, { 'n', 'mm' },
}, },
run = 'bash ./install.sh', run = 'bash ./install.sh', -- 自动下载使用的本地词库
requires = 'kharji/sqlite.lua',
config = function() config = function()
require("Trans").setup {} require("Trans").setup {} -- 启动Trans
vim.keymap.set("v", "mm", '<Esc><Cmd>TranslateSelectWord<CR>', { desc = ' Translate' }) vim.keymap.set({"v", 'n'}, "mm", '<Cmd>Translate<CR>', { desc = ' Translate' }) -- 自动判断virtual 还是 normal 模式
vim.keymap.set("n", "mm", "<Cmd>TranslateCursorWord<CR>", { desc = ' Translate' }) vim.keymap.set("n", "mi", "<Cmd>TranslateInput<CR>", { desc = ' Translate' })
end end
} }
``` ```
@ -90,7 +95,6 @@ use {
> `sudo pacman -S sqlite # Arch` > `sudo pacman -S sqlite # Arch`
> `sudo apt-get install sqlite3 libsqlite3-dev # Ubuntu` > `sudo apt-get install sqlite3 libsqlite3-dev # Ubuntu`
- `$HOME/.vim/dict` 文件夹是否存在
> 后续会增加 `healthcheck` 进行检查 > 后续会增加 `healthcheck` 进行检查
@ -98,15 +102,16 @@ use {
```lua ```lua
require'Trans'.setup { require'Trans'.setup {
view = { view = {
input = 'hover', input = 'float',
n = 'hover', n = 'hover',
v = 'hover', v = 'hover',
}, },
window = { window = {
border = 'rounded', border = 'rounded',
animation = true,
hover = { hover = {
width = 36, width = 36,
height = 23, height = 26,
}, },
float = { float = {
width = 0.8, width = 0.8,
@ -121,8 +126,6 @@ require'Trans'.setup {
'pos', 'pos',
'exchange', 'exchange',
'translation', 'translation',
-- NOTE :如果你想限制某个组件的行数可以设置max_size
-- { 'Definition', max_size = 4 },
'definition', 'definition',
-- }, -- },
-- online = { -- online = {
@ -130,14 +133,15 @@ require'Trans'.setup {
-- }, -- },
}, },
icon = { icon = {
title = ' ', -- 
star = '', star = '',
notfound = '', -- notfound = '',
yes = '', -- yes = '',
no = '' -- no = ''
-- star = '⭐', -- star = '⭐',
-- notfound = '❔', notfound = '❔',
-- yes = '✔️', yes = '✔️',
-- no = '❌' no = '❌'
}, },
db_path = '$HOME/.vim/dict/ultimate.db', db_path = '$HOME/.vim/dict/ultimate.db',
-- TODO : -- TODO :
@ -145,11 +149,11 @@ require'Trans'.setup {
-- -- TODO -- -- TODO
-- 'offline', -- 'offline',
-- } -- }
map = { keymap = {
-- TODO -- TODO : More action support
hover = { hover = {
pageup = '<C-u>', pageup = '[[',
pagedown = '<C-d>', pagedown = ']]',
}, },
}, },
-- history = { -- history = {
@ -185,10 +189,16 @@ vim.keymap.set('n', 'mi', '<Cmd>TranslateInput<CR>')
- 本插件词典基于[ECDICT](https://github.com/skywind3000/ECDICT) - 本插件词典基于[ECDICT](https://github.com/skywind3000/ECDICT)
## 感谢 ## 感谢
- [ECDICT](https://github.com/skywind3000/ECDICT) - [ECDICT](https://github.com/skywind3000/ECDICT) 本地词典的提供
- [sqlite.lua](https://github.com/kharji/sqlite.lua) - [sqlite.lua](https://github.com/kharji/sqlite.lua) 数据库访问
- [T.vim](https://github.com/sicong-li/T.vim) - [T.vim](https://github.com/sicong-li/T.vim) 灵感来源
# TODO ## TODO
- 多风格样式
- ~~移动光标自动关闭窗口~~ - ~~移动光标自动关闭窗口~~
- 多风格样式
- 历史查询结果保存
- 在线多引擎异步查询
- 快捷键定义
- 自动读音
- `句子翻译` | `中翻英` 的支持
- 重新录制屏幕截图示例

View File

@ -135,7 +135,7 @@ M.hover = {
expl(content, '英文注释') expl(content, '英文注释')
vim.tbl_map(function(def) vim.tbl_map(function(def)
def = def:gsub('%s+', '', 1) def = def:gsub('%s+', '', 1) -- TODO :判断是否需要分割空格
content:addline(indent .. def, 'TransDefinition') content:addline(indent .. def, 'TransDefinition')
end, vim.split(indent .. result.definition, '\n', { plain = true, trimempry = true })) end, vim.split(indent .. result.definition, '\n', { plain = true, trimempry = true }))