Dooing 项目教程

1. 项目目录结构及介绍

Dooing 是一个为 Neovim 设计的极简待办事项列表管理器，其目录结构如下：

dooing/
├── .github/             # GitHub 相关配置文件
├── doc/                 # 项目文档
├── lua/                 # Lua 脚本文件
├── plugin/              # Neovim 插件文件
├── LICENSE              # 项目许可证文件
├── README.md            # 项目说明文件

• .github/: 存放 GitHub 仓库的配置文件，如 Issue 模板等。
• doc/: 包含项目的文档和相关的说明文件。
• lua/: 存放 Lua 脚本，这些脚本负责 Dooing 的核心功能。
• plugin/: 包含 Neovim 插件文件，这些文件负责与 Neovim 集成。
• LICENSE: 项目使用的 MIT 许可证文件。
• README.md: 项目的主要说明文件，包含项目的介绍、安装和使用方法。

2. 项目的启动文件介绍

Dooing 的启动文件位于 plugin/dooing.vim。这个文件是 Neovim 插件的主要入口点，负责加载 Lua 脚本并设置 Neovim 的相关配置。

启动文件的主要功能包括：

• 定义 Neovim 的命令和快捷键。
• 设置插件配置项，如待办事项的保存路径、窗口大小等。
• 加载 Lua 脚本，实现待办事项的增删改查等功能。

3. 项目的配置文件介绍

Dooing 的配置文件位于 lua/dooing.lua。这个文件包含了插件的默认配置和用户自定义配置的接口。

配置文件的主要内容包括：

• save_path: 设置待办事项数据的保存路径。
• timestamp: 设置是否启用相对时间戳。
• window: 设置待办事项窗口的大小、位置和边框样式。
• formatting: 设置待办事项的显示格式，包括不同状态（待办、进行中、已完成）的图标和格式。
• quick_keys: 设置是否启用快速键。
• notes: 设置便签的图标。
• scratchpad: 设置便签的语法高亮。
• keymaps: 设置快捷键映射，包括打开/关闭窗口、添加待办事项、切换待办状态等操作。
• calendar: 设置日历功能的配置项，如语言和快捷键映射。
• priorities 和 priority_groups: 设置待办事项的优先级和优先级组。

用户可以通过覆盖这些默认配置项来自定义 Dooing 的行为，以满足个人的使用习惯。