easyread.nvim 项目教程

easyread.nvim 项目教程

easyread.nvimbionic-like reading inside Neovim项目地址:https://gitcode.com/gh_mirrors/ea/easyread.nvim

1. 项目的目录结构及介绍

easyread.nvim/
├── assets/
│   └── ...
├── lua/
│   └── easyread/
│       └── ...
├── LICENSE
├── README.md
└── ...

• assets/: 包含项目相关的资源文件。
• lua/easyread/: 包含项目的核心 Lua 脚本文件。
• LICENSE: 项目的许可证文件，采用 MIT 许可证。
• README.md: 项目的介绍文档，包含安装、配置和使用说明。

2. 项目的启动文件介绍

项目的启动文件位于 lua/easyread/init.lua。该文件负责初始化插件并加载必要的配置。

-- lua/easyread/init.lua
require('easyread').setup({
    hlValues = {
        ['1'] = 1,
        ['2'] = 1,
        ['3'] = 2,
        ['4'] = 2,
        ['fallback'] = 1
    },
    saccadeInterval = 500,
    saccadeReset = true,
    whileInsert = true
})

3. 项目的配置文件介绍

项目的配置文件可以通过调用 setup 函数进行自定义配置。默认配置如下：

require('easyread').setup({
    hlValues = {
        ['1'] = 1,
        ['2'] = 1,
        ['3'] = 2,
        ['4'] = 2,
        ['fallback'] = 1
    },
    saccadeInterval = 500,
    saccadeReset = true,
    whileInsert = true
})

• hlValues: 定义不同级别的突出显示值。
• saccadeInterval: 定义眼睛扫视的时间间隔。
• saccadeReset: 是否在每行更新时重置扫视间隔。
• whileInsert: 是否在插入模式下更新突出显示。

通过以上配置，用户可以根据自己的需求调整插件的行为。

easyread.nvimbionic-like reading inside Neovim项目地址:https://gitcode.com/gh_mirrors/ea/easyread.nvim