mdeval.nvim 项目教程
1. 项目的目录结构及介绍
mdeval.nvim/
├── LICENSE
├── README.md
├── doc/
│ └── mdeval.txt
├── lua/
│ ├── mdeval/
│ │ ├── init.lua
│ │ ├── config.lua
│ │ ├── eval.lua
│ │ └── utils.lua
│ └── mdeval.lua
├── plugin/
│ └── mdeval.vim
└── tests/
└── test_mdeval.vim
- LICENSE: 项目的许可证文件。
- README.md: 项目的介绍文档。
- doc/: 包含项目的帮助文档。
- lua/: 包含项目的主要逻辑代码。
- mdeval/: 包含项目的核心功能模块。
- init.lua: 项目的初始化文件。
- config.lua: 项目的配置管理文件。
- eval.lua: 代码块评估功能的实现文件。
- utils.lua: 工具函数文件。
- mdeval.lua: 项目的入口文件。
- mdeval/: 包含项目的核心功能模块。
- plugin/: 包含项目的插件文件。
- tests/: 包含项目的测试文件。
2. 项目的启动文件介绍
项目的启动文件是 lua/mdeval.lua
。这个文件负责初始化插件,并加载必要的模块和配置。
require('mdeval').setup()
3. 项目的配置文件介绍
项目的配置文件是 lua/mdeval/config.lua
。这个文件定义了插件的默认配置,并提供了用户自定义配置的接口。
local config = {
-- 默认配置项
auto_evaluate = true,
confirm_execution = true,
-- 其他配置项...
}
return config
用户可以通过在 init.lua
中调用 setup
函数来覆盖默认配置:
require('mdeval').setup({
auto_evaluate = false,
confirm_execution = false,
-- 其他自定义配置项...
})