Obsidian CardBoard 项目教程
1. 项目的目录结构及介绍
Obsidian CardBoard 项目的目录结构如下:
obsidian-card-board/
├── main.ts
├── styles.css
├── manifest.json
├── README.md
└── src/
├── main.ts
├── styles.css
└── ...
main.ts
: 项目的主入口文件。styles.css
: 项目的样式文件。manifest.json
: 项目的配置文件。README.md
: 项目的说明文档。src/
: 包含项目的源代码文件。
2. 项目的启动文件介绍
项目的启动文件是 main.ts
,它负责初始化插件并加载必要的资源。以下是 main.ts
的主要功能:
import { Plugin } from 'obsidian';
import { CardBoard } from './src/main';
export default class CardBoardPlugin extends Plugin {
async onload() {
this.addRibbonIcon('dice', 'CardBoard', () => {
new CardBoard(this.app).open();
});
}
}
Plugin
: 导入 Obsidian 的插件类。CardBoard
: 导入 CardBoard 主类。CardBoardPlugin
: 定义插件类,继承自Plugin
。onload
: 插件加载时执行的函数,添加了一个侧边栏图标,点击后打开 CardBoard 界面。
3. 项目的配置文件介绍
项目的配置文件是 manifest.json
,它包含了插件的基本信息和依赖项。以下是 manifest.json
的内容:
{
"id": "card-board",
"name": "CardBoard",
"version": "0.7.2",
"minAppVersion": "0.12.0",
"description": "A Kanban-style task manager for Obsidian.",
"author": "roovo",
"authorUrl": "https://github.com/roovo",
"isDesktopOnly": false
}
id
: 插件的唯一标识符。name
: 插件的名称。version
: 插件的版本号。minAppVersion
: 插件支持的最低 Obsidian 版本。description
: 插件的描述。author
: 插件的作者。authorUrl
: 作者的网址。isDesktopOnly
: 是否仅支持桌面版 Obsidian。