Obsidian-RSS 插件使用教程

Obsidian-RSS 插件使用教程

1. 项目目录结构及介绍

obsidian-rss/
├── .github/
│   └── workflows/
├── .obsidian/
│   └── plugins/
├── src/
│   ├── main.ts
│   ├── settings.ts
│   ├── styles.scss
│   └── views/
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录结构说明

• .github/workflows/: 存放 GitHub Actions 的工作流配置文件。
• .obsidian/plugins/: 存放 Obsidian 插件的配置文件。
• src/: 项目的主要源代码目录。
  • main.ts: 项目的入口文件。
  • settings.ts: 项目的配置文件。
  • styles.scss: 项目的样式文件。
  • views/: 存放项目的视图文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖管理文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

main.ts

main.ts 是 Obsidian-RSS 插件的入口文件，负责初始化插件并加载相关功能。以下是 main.ts 的主要功能：

import { Plugin } from 'obsidian';
import { RSSSettingsTab } from './settings';

export default class RSSPlugin extends Plugin {
    async onload() {
        console.log('加载 RSS 插件');
        this.addSettingTab(new RSSSettingsTab(this.app, this));
    }

    onunload() {
        console.log('卸载 RSS 插件');
    }
}

功能说明

• onload(): 插件加载时执行的函数，初始化插件并加载设置页面。
• onunload(): 插件卸载时执行的函数，清理插件资源。

3. 项目的配置文件介绍

settings.ts

settings.ts 文件定义了插件的配置选项和设置页面。以下是 settings.ts 的主要内容：

import { PluginSettingTab, Setting } from 'obsidian';
import RSSPlugin from './main';

export class RSSSettingsTab extends PluginSettingTab {
    plugin: RSSPlugin;

    constructor(app: App, plugin: RSSPlugin) {
        super(app, plugin);
        this.plugin = plugin;
    }

    display(): void {
        let { containerEl } = this;
        containerEl.empty();

        new Setting(containerEl)
            .setName('RSS Feed URL')
            .setDesc('输入 RSS 订阅的 URL')
            .addText(text => text
                .setPlaceholder('https://example.com/rss')
                .onChange(async (value) => {
                    this.plugin.settings.rssUrl = value;
                    await this.plugin.saveSettings();
                }));
    }
}

功能说明

• RSSSettingsTab: 定义了插件的设置页面，用户可以在此输入 RSS 订阅的 URL。
• addText(): 添加一个文本输入框，用于输入 RSS 订阅的 URL。
• onChange(): 当用户输入 URL 时，保存设置并更新插件配置。

---

以上是 Obsidian-RSS 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该插件。