Obsidian Spaced Repetition Recall 插件安装与使用教程

Obsidian Spaced Repetition Recall 插件安装与使用教程

obsidian-spaced-repetition-recall Fight the forgetting curve by reviewing flashcards & entire notes on Obsidian.md 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-spaced-repetition-recall

1. 项目目录结构及介绍

obsidian-spaced-repetition-recall 插件的目录结构如下：

obsidian-spaced-repetition-recall/
├── assets/                       # 资源文件目录
├── docs/                        # 文档目录
├── src/                         # 源代码目录
├── tests/                       # 测试代码目录
├── utils/                       # 工具类目录
├── .github/                     # GitHub 工作流和配置文件
├── .gitignore                   # Git 忽略文件
├── .prettierrc.json             # Prettier 配置文件
├── .eslintrc.json               # ESLint 配置文件
├── CHANGELOG.md                 # 更新日志
├── CODE_OF_CONDUCT.md           # 行为准则
├── CONTRIBUTING.md              # 贡献指南
├── LICENSE                      # 许可证文件
├── Makefile                     # Makefile 文件
├── README.md                    # 项目说明文件
├── esbuild.config.mjs           # esbuild 配置文件
├── jest.config.js               # Jest 测试配置文件
├── manifest.json                # 插件配置文件
├── mkdocs.yml                    # MkDocs 配置文件
├── package-lock.json            # npm 包锁定文件
├── package.json                 # npm 包配置文件
├── pnpm-lock.yaml               # pnpm 锁定文件
├── requirements.txt             # 项目依赖文件
├── styles.css                   # 样式文件
├── tsconfig.json                # TypeScript 配置文件
└── versions.json                # 版本信息文件

• assets/: 存放项目所需的静态资源文件。
• docs/: 存放项目文档。
• src/: 存放插件的源代码。
• tests/: 存放项目的测试代码。
• utils/: 存放一些工具类函数或模块。
• .github/: 存放 GitHub 工作流和配置文件。
• .gitignore: 指定 Git 忽略的文件。
• .prettierrc.json: Prettier 的配置文件，用于格式化代码。
• .eslintrc.json: ESLint 的配置文件，用于代码质量检查。
• CHANGELOG.md: 记录项目的更新历史。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 指导如何为项目贡献代码。
• LICENSE: 项目使用的许可证。
• Makefile: Makefile 文件，用于自动化构建过程。
• README.md: 项目说明文件，介绍项目的相关信息。
• esbuild.config.mjs: esbuild 的配置文件。
• jest.config.js: Jest 的测试配置文件。
• manifest.json: 插件的配置文件，定义插件的基本信息和功能。
• mkdocs.yml: MkDocs 的配置文件，用于生成文档网站。
• package-lock.json: npm 的包锁定文件。
• package.json: npm 的包配置文件，定义项目的依赖和脚本。
• pnpm-lock.yaml: pnpm 的锁定文件。
• requirements.txt: 项目依赖文件。
• styles.css: 插件的样式文件。
• tsconfig.json: TypeScript 的配置文件。
• versions.json: 记录项目版本信息的文件。

2. 项目的启动文件介绍

项目的启动主要是通过 manifest.json 文件来配置。该文件位于项目根目录，是定义插件信息和功能的主要文件。

{
  "id": "obsidian-spaced-repetition-recall",
  "name": "Spaced Repetition Recall",
  "version": "1.12.5.14",
  "description": "Flashcard-Based and Note-Based Spaced Repetition Plugin",
  "author": "open-spaced-repetition",
  "namespace": "obsidian-spaced-repetition-recall",
  "publisher": "open-spaced-repetition",
  "icons": {
    "16": "path/to/icon/16.png",
    "32": "path/to/icon/32.png",
    "48": "path/to/icon/48.png",
    "128": "path/to/icon/128.png"
  },
  "main": "path/to/main.js",
  "dependencies": {
    "some-dependency": "^1.0.0"
  },
  "Vault": {
    "minimum": "0.0.0",
    "maximum": "0.0.0"
  },
  "features": {
    "editor": "advanced",
    "platform": "desktop"
  }
}

• "id"：插件的唯一标识符。
• "name"：插件的名称。
• "version"：插件的版本号。
• "description"：插件的描述信息。
• "author"：插件作者的名称。
• "namespace"：插件的命名空间。
• "publisher"：插件的发布者。
• "icons"：插件在不同尺寸下的图标文件路径。
• "main"：插件的入口文件路径。
• "dependencies"：插件的依赖。
• "Vault"：指定插件支持的 Obsidian 版本范围。
• "features"：插件的特性支持。

3. 项目的配置文件介绍

项目的配置文件主要是 main.js，这是插件的入口文件。以下是 main.js 文件的基本结构：

class SpacedRepetitionRecallPlugin {
  constructor(app) {
    this.app = app;
    // 初始化代码
  }

  async onload() {
    // 加载插件时执行的代码
  }

  async onunload() {
    // 卸载插件时执行的代码
  }

  // 其他插件功能相关的函数
}

module.exports = {
  SpacedRepetitionRecallPlugin,
};

• constructor(app): 构造函数，接收 Obsidian 应用实例。
• onload(): 当插件加载时触发的方法，用于初始化插件。
• onunload(): 当插件卸载时触发的方法，用于清理资源。
• module.exports: 导出插件类，供 Obsidian 调用。

在配置插件时，还需要根据实际情况编写代码，以实现插件的具体功能。这通常包括监听用户事件、处理数据、更新 UI 等操作。具体的配置和实现细节取决于插件的特定需求。

obsidian-spaced-repetition-recall Fight the forgetting curve by reviewing flashcards & entire notes on Obsidian.md 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-spaced-repetition-recall