Flashcards-Obsidian 插件使用教程

Flashcards-Obsidian 插件使用教程

flashcards-obsidian🎴 An Anki plugin for Obsidian.md项目地址:https://gitcode.com/gh_mirrors/fl/flashcards-obsidian

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

Flashcards-Obsidian 插件的目录结构如下：

flashcards-obsidian/
├── .github/
│   └── workflows/
├── assets/
│   └── icon.png
├── src/
│   ├── main.ts
│   ├── styles.css
│   └── settings.ts
├── .gitignore
├── .obsidian.publish.json
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

目录结构介绍

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• assets/: 存放插件的图标文件。
• src/: 插件的主要源代码文件夹。
  • main.ts: 插件的主入口文件。
  • styles.css: 插件的样式文件。
  • settings.ts: 插件的设置相关代码。
• .gitignore: 指定 Git 忽略的文件和文件夹。
• .obsidian.publish.json: Obsidian 发布配置文件。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• package.json: 项目的依赖和脚本配置文件。
• tsconfig.json: TypeScript 配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。这个文件是插件的入口点，负责初始化插件并注册各种事件和命令。

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

export default class FlashcardsPlugin extends Plugin {
    async onload() {
        console.log('加载 Flashcards 插件');
        // 注册设置选项卡
        this.addSettingTab(new FlashcardsSettingsTab(this.app, this));
    }

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

3. 项目的配置文件介绍

项目的配置文件主要包括 package.json 和 .obsidian.publish.json。

package.json

package.json 文件定义了项目的依赖、脚本和其他元数据。

{
  "name": "flashcards-obsidian",
  "version": "1.0.0",
  "description": "A flashcards plugin for Obsidian",
  "main": "main.js",
  "scripts": {
    "dev": "rollup --config rollup.config.js --watch",
    "build": "rollup --config rollup.config.js"
  },
  "keywords": [],
  "author": "",
  "license": "MIT",
  "devDependencies": {
    "@rollup/plugin-commonjs": "^15.0.0",
    "@rollup/plugin-node-resolve": "^9.0.0",
    "@rollup/plugin-typescript": "^6.0.0",
    "obsidian": "^0.12.0",
    "rollup": "^2.38.0",
    "tslib": "^2.0.3",
    "typescript": "^4.1.3"
  }
}

.obsidian.publish.json

.obsidian.publish.json 文件是 Obsidian 发布配置文件，用于配置插件的发布选项。

{
  "id": "flashcards-obsidian",
  "name": "Flashcards",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "A flashcards plugin for Obsidian",
  "author": "Your Name",
  "authorUrl": "https://yourwebsite.com",
  "isDesktopOnly": false
}

以上是 Flashcards-Obsidian 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

flashcards-obsidian🎴 An Anki plugin for Obsidian.md项目地址:https://gitcode.com/gh_mirrors/fl/flashcards-obsidian