MMM-Todoist 项目使用教程
1. 项目的目录结构及介绍
MMM-Todoist 是一个用于 MagicMirror² 平台的扩展模块,用于在 MagicMirror 上显示 Todoist 任务。以下是该项目的目录结构及其介绍:
MMM-Todoist/
├── LICENSE
├── MMM-Todoist.css
├── MMM-Todoist.js
├── README.md
├── node_helper.js
├── package-lock.json
├── package.json
├── todoist-avatars.png
└── todoist.png
LICENSE
: 项目许可证文件。MMM-Todoist.css
: 模块的样式文件。MMM-Todoist.js
: 模块的主 JavaScript 文件。README.md
: 项目的说明文档。node_helper.js
: 用于后台处理的 Node.js 辅助文件。package-lock.json
: 锁定依赖版本的文件。package.json
: 项目的依赖和元数据文件。todoist-avatars.png
: Todoist 头像图片。todoist.png
: Todoist 图标图片。
2. 项目的启动文件介绍
MMM-Todoist 模块的启动文件是 MMM-Todoist.js
。该文件负责初始化模块并处理前端显示逻辑。以下是 MMM-Todoist.js
的主要功能:
- 初始化模块配置。
- 加载 Todoist 任务数据。
- 更新前端显示。
3. 项目的配置文件介绍
MMM-Todoist 模块的配置文件是 config.js
,通常位于 MagicMirror 项目的 config
目录下。以下是一个示例配置:
{
module: 'MMM-Todoist',
position: 'bottom_right',
header: 'Todoist',
config: {
hideWhenEmpty: false,
accessToken: 'your_todoist_access_token',
maximumEntries: 60,
updateInterval: 10 * 60 * 1000, // 每 10 分钟更新一次
fade: false,
projects: [2326180937],
labels: ["MagicMirror", "Important"]
}
}
module
: 指定模块名称。position
: 指定模块在 MagicMirror 中的显示位置。header
: 模块的标题。config
: 模块的具体配置选项:hideWhenEmpty
: 是否在任务为空时隐藏模块。accessToken
: Todoist 的访问令牌。maximumEntries
: 显示的最大任务数量。updateInterval
: 更新频率(以毫秒为单位)。fade
: 是否启用渐变效果。projects
: 要显示的任务所属的项目 ID 列表。labels
: 要显示的任务标签列表。
通过以上配置,您可以自定义 MMM-Todoist 模块在 MagicMirror 上的显示效果和行为。