Obsidian Tasks Calendar Wrapper 项目教程

Obsidian Tasks Calendar Wrapper 项目教程

obsidian-tasks-calendar-wrapperThis plugin currently provides a timeline view to display your tasks from your obsidian valut, with customizable filters and renderring options.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-tasks-calendar-wrapper

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

Obsidian Tasks Calendar Wrapper 项目的目录结构如下：

obsidian-tasks-calendar-wrapper/
├── .github/
│   └── workflows/
│       └── main.yml
├── assets/
│   └── icon.png
├── src/
│   ├── main.ts
│   └── styles.css
├── .gitignore
├── .obsidian/
│   └── plugins/
│       └── tasks-calendar-wrapper/
│           └── data.json
├── LICENSE
├── README.md
└── package.json

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• assets/: 存放项目的静态资源，如图标等。
• src/: 项目的源代码目录，包含主要的 TypeScript 文件和样式文件。
• .gitignore: 指定 Git 忽略的文件和目录。
• .obsidian/plugins/tasks-calendar-wrapper/: 存放 Obsidian 插件的配置数据。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和脚本配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/main.ts。这个文件是插件的主入口点，负责初始化插件并加载必要的资源。

// src/main.ts
import { Plugin } from 'obsidian';
import { TasksCalendarWrapper } from './tasks-calendar-wrapper';

export default class TasksCalendarWrapperPlugin extends Plugin {
    async onload() {
        console.log('加载 Tasks Calendar Wrapper 插件');
        this.addRibbonIcon('calendar-days', 'Tasks Calendar Wrapper', () => {
            new TasksCalendarWrapper(this.app).open();
        });
    }

    onunload() {
        console.log('卸载 Tasks Calendar Wrapper 插件');
    }
}

启动文件介绍

• Plugin: 继承自 Obsidian 的插件基类。
• TasksCalendarWrapper: 插件的主要逻辑类。
• onload(): 插件加载时调用的方法，负责初始化和添加功能。
• onunload(): 插件卸载时调用的方法，负责清理资源。

3. 项目的配置文件介绍

项目的配置文件主要位于 .obsidian/plugins/tasks-calendar-wrapper/data.json。这个文件包含了插件的配置数据，如用户设置、日历视图的布局等。

{
    "calendarView": "month",
    "showCompletedTasks": true,
    "taskColors": {
        "default": "#000000",
        "overdue": "#FF0000"
    }
}

配置文件介绍

• calendarView: 日历视图的类型，如月视图、周视图等。
• showCompletedTasks: 是否显示已完成任务的标志。
• taskColors: 任务的颜色配置，包括默认颜色和逾期任务的颜色。

以上是 Obsidian Tasks Calendar Wrapper 项目的详细教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

obsidian-tasks-calendar-wrapperThis plugin currently provides a timeline view to display your tasks from your obsidian valut, with customizable filters and renderring options.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-tasks-calendar-wrapper