Obsidian Spaced Repetition 插件使用教程

1. 项目目录结构及介绍

Obsidian Spaced Repetition 插件的目录结构如下：

obsidian-spaced-repetition/
├── assets/
├── docs/
├── src/
├── tests/
├── .eslintrc.json
├── .gitignore
├── .npmrc
├── .prettierignore
├── .prettierrc.json
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── Makefile
├── README.md
├── esbuild.config.mjs
├── jest.config.js
├── manifest.json
├── mkdocs.yml
├── package.json
├── pnpm-lock.yaml
├── requirements.txt
├── styles.css
├── tsconfig.json
├── versions.json
└── wdio.conf.js

目录介绍

• assets/: 存放项目所需的静态资源文件。
• docs/: 存放项目的文档文件。
• src/: 存放项目的源代码文件。
• tests/: 存放项目的测试代码文件。
• .eslintrc.json: ESLint 配置文件，用于代码风格检查。
• .gitignore: Git 忽略文件配置。
• .npmrc: npm 配置文件。
• .prettierignore: Prettier 忽略文件配置。
• .prettierrc.json: Prettier 配置文件，用于代码格式化。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 项目贡献指南。
• LICENSE: 项目许可证文件。
• Makefile: Makefile 文件，用于自动化构建。
• README.md: 项目介绍和使用说明。
• esbuild.config.mjs: esbuild 配置文件，用于打包。
• jest.config.js: Jest 配置文件，用于测试。
• manifest.json: 插件的 manifest 文件，包含插件的基本信息。
• mkdocs.yml: MkDocs 配置文件，用于生成文档。
• package.json: npm 包配置文件，包含项目的依赖和脚本。
• pnpm-lock.yaml: pnpm 锁定文件，用于版本控制。
• requirements.txt: 项目依赖文件。
• styles.css: 项目样式文件。
• tsconfig.json: TypeScript 配置文件。
• versions.json: 版本信息文件。
• wdio.conf.js: WebdriverIO 配置文件，用于自动化测试。

2. 项目启动文件介绍

Obsidian Spaced Repetition 插件的启动文件主要位于 src/ 目录下。以下是主要的启动文件：

• main.ts: 插件的主入口文件，负责初始化插件并加载其他模块。
• settings.ts: 插件的设置文件，负责处理用户设置和配置。
• reviewer.ts: 负责处理闪卡和笔记的复习逻辑。

3. 项目配置文件介绍

Obsidian Spaced Repetition 插件的配置文件主要包括以下几个：

• manifest.json: 插件的 manifest 文件，包含插件的基本信息，如名称、版本、描述、作者等。
• package.json: npm 包配置文件，包含项目的依赖、脚本、版本等信息。
• tsconfig.json: TypeScript 配置文件，定义 TypeScript 编译选项。
• esbuild.config.mjs: esbuild 配置文件，定义打包选项。
• jest.config.js: Jest 配置文件，定义测试选项。
• wdio.conf.js: WebdriverIO 配置文件，定义自动化测试选项。

这些配置文件共同作用，确保插件能够正确编译、打包、测试和运行。