Obsidian Wikipedia 插件使用教程

1. 项目目录结构及介绍

Obsidian Wikipedia 插件的项目目录结构如下：

• .github/
  • 存放与 GitHub Actions 相关的配置文件。
• ./
  • README.md：项目说明文件。
  • LICENSE.md：项目许可证文件。
  • main.ts：插件的主要逻辑文件。
  • manifest.json：插件的配置文件。
  • package.json：项目依赖和脚本定义文件。
  • rollup.config.js：Rollup 打包工具的配置文件。
  • tsconfig.json：TypeScript 配置文件。
  • versions.json：版本信息文件。
  • .gitignore：Git 忽略文件列表。

2. 项目的启动文件介绍

插件的启动文件是 main.ts，它包含了插件的主要逻辑。在这个文件中，插件定义了两个命令：

• Get Wikipedia for Active Note：使用当前活动笔记的标题作为搜索词，获取 Wikipedia 的第一段内容并粘贴到笔记中。
• Get Wikipedia for Search Term：获取用户指定的搜索词对应的 Wikipedia 第一段内容。

这些命令的实现依赖于对 Obsidian API 的调用以及网络请求来获取 Wikipedia 的内容。

3. 项目的配置文件介绍

插件的配置文件是 manifest.json，它定义了插件的元数据和配置选项。以下是一些主要的配置项：

• name：插件名称。
• id：插件的唯一标识符。
• version：插件的版本号。
• description：插件的描述信息。
• author：插件作者的名称。
• url：插件的 URL，通常是 GitHub 仓库的链接。
• minAppVersion：插件所需的最小 Obsidian 应用版本。
• permissions：插件所需的权限，例如访问剪切板、活动笔记等。
• settings：插件的设置，包括语言前缀、是否加粗搜索词、是否使用段落模板等。

通过修改 manifest.json 文件中的配置项，可以调整插件的名称、描述、版本等元数据，以及定义插件在 Obsidian 中的行为。