Obsidian Zotero Integration 项目教程

Obsidian Zotero Integration 项目教程

obsidian-zotero-integration Insert and import citations, bibliographies, notes, and PDF annotations from Zotero into Obsidian. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-zotero-integration

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

obsidian-zotero-integration/
├── .github/
│   └── workflows/
├── assets/
│   ├── css/
│   └── icons/
├── src/
│   ├── main.ts
│   ├── settings.ts
│   └── utils.ts
├── .gitignore
├── LICENSE
├── README.md
├── package.json
└── tsconfig.json

• .github/workflows/: 包含GitHub Actions的工作流配置文件。
• assets/: 存放项目的静态资源，如CSS样式文件和图标。
• src/: 项目的源代码目录，包含主要的TypeScript文件。
  • main.ts: 项目的入口文件。
  • settings.ts: 处理项目的配置和设置。
  • utils.ts: 包含一些通用的工具函数。
• .gitignore: 指定Git版本控制系统忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• package.json: 项目的依赖管理文件，包含项目的元数据和依赖包。
• tsconfig.json: TypeScript的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 src/main.ts。这个文件是整个插件的入口点，负责初始化插件并加载必要的模块。以下是 main.ts 的主要功能：

• 初始化插件: 在Obsidian启动时，插件会被加载并初始化。
• 注册命令: 注册插件提供的命令，用户可以通过Obsidian的命令面板调用这些命令。
• 加载设置: 从配置文件中加载用户的设置，并应用到插件中。

3. 项目的配置文件介绍

项目的配置文件主要是 src/settings.ts。这个文件负责处理插件的配置和用户设置。以下是 settings.ts 的主要功能：

• 加载和保存设置: 从Obsidian的配置文件中加载用户的设置，并在用户更改设置时保存这些设置。
• 默认设置: 提供默认的配置选项，确保插件在没有用户自定义设置的情况下也能正常工作。
• 配置界面: 提供一个用户界面，允许用户在Obsidian的设置面板中修改插件的配置。

通过这些配置，用户可以自定义插件的行为，例如设置Zotero的API密钥、选择要同步的文献库等。

obsidian-zotero-integration Insert and import citations, bibliographies, notes, and PDF annotations from Zotero into Obsidian. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-zotero-integration