Obsidian Todoist 插件使用教程

Obsidian Todoist 插件使用教程

obsidian-todoist-pluginMaterialize Todoist tasks in Obsidian notes项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-todoist-plugin

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

Obsidian Todoist 插件的目录结构如下：

obsidian-todoist-plugin/
├── .github/
├── docs/
├── src/
│   ├── assets/
│   ├── commands/
│   ├── components/
│   ├── lib/
│   ├── styles/
│   ├── main.ts
│   ├── manifest.json
│   └── versions.json
├── .envrc
├── .gitattributes
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── biome.json
└── manifest.json

目录介绍：

• .github/: 包含 GitHub 相关配置文件。
• docs/: 包含项目文档。
• src/: 源代码目录。
  • assets/: 静态资源文件。
  • commands/: 命令相关代码。
  • components/: 组件相关代码。
  • lib/: 库文件。
  • styles/: 样式文件。
  • main.ts: 主入口文件。
  • manifest.json: 插件清单文件。
  • versions.json: 版本信息文件。
• .envrc: 环境配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略配置文件。
• CHANGELOG.md: 更新日志。
• LICENSE: 许可证文件。
• README.md: 项目说明文件。
• biome.json: 项目配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。这个文件是插件的入口点，负责初始化插件并加载相关功能。

// src/main.ts
import { Plugin } from 'obsidian';
import { TodoistPluginSettings, TodoistPluginSettingsTab } from './lib/settings';
import { TodoistSync } from './lib/sync';

export default class TodoistPlugin extends Plugin {
    settings: TodoistPluginSettings;

    async onload() {
        await this.loadSettings();

        this.addSettingTab(new TodoistPluginSettingsTab(this.app, this));

        this.addCommand({
            id: 'sync-with-todoist',
            name: 'Sync with Todoist',
            callback: () => {
                new TodoistSync(this.settings).sync();
            }
        });
    }

    async loadSettings() {
        this.settings = Object.assign({}, DEFAULT_SETTINGS, await this.loadData());
    }

    async saveSettings() {
        await this.saveData(this.settings);
    }
}

3. 项目的配置文件介绍

manifest.json

manifest.json 文件是 Obsidian 插件的清单文件，包含了插件的基本信息和版本信息。

{
    "id": "obsidian-todoist-plugin",
    "name": "Todoist Plugin",
    "version": "1.13.0",
    "minAppVersion": "0.12.0",
    "description": "Materialize Todoist tasks in Obsidian notes",
    "author": "jamiebrynes7",
    "authorUrl": "https://github.com/jamiebrynes7",
    "isDesktopOnly": false
}

versions.json

versions.json 文件包含了插件的版本历史信息。

{
    "1.13.0": "Update for Obsidian 0.12.0 compatibility",
    "1.12.0": "Add new features and bug fixes",
    "1.11.0": "Initial release"
}

通过以上介绍，您可以更好地理解和使用 Obsidian Todoist 插件。希望这份教程对您有所帮助！

obsidian-todoist-pluginMaterialize Todoist tasks in Obsidian notes项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-todoist-plugin