Obsidian Core Search Assistant 插件教程

4 0 0

Obsidian Core Search Assistant 插件教程

obsidian-core-search-assistant-pluginAn Obsidian plugin to enhance built-in search: keyboard interface, card preview, bigger preview项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-core-search-assistant-plugin

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

Obsidian Core Search Assistant 插件的目录结构如下：


obsidian-core-search-assistant-plugin/
├── src/
│   ├── editorconfig
│   ├── eslintignore
│   ├── eslintrc.js
│   ├── gitignore
│   ├── prettierrc
│   ├── LICENSE
│   ├── README.md
│   ├── esbuild.config.mjs
│   ├── manifest.json
│   ├── package.json
│   ├── styles.scss
│   ├── tsconfig.json
│   └── versions.json
├── LICENSE
├── README.md
└── ...

目录结构介绍：

src/: 包含插件的主要源代码文件。
editorconfig: 编辑器配置文件。eslintignore: ESLint 忽略配置文件。eslintrc.js: ESLint 配置文件。gitignore: Git 忽略配置文件。prettierrc: Prettier 格式化配置文件。LICENSE: 许可证文件。README.md: 项目说明文档。esbuild.config.mjs: esbuild 配置文件。manifest.json: 插件的 manifest 文件，包含插件的基本信息。package.json: 项目的依赖和脚本配置文件。styles.scss: 样式文件。tsconfig.json: TypeScript 配置文件。versions.json: 版本信息文件。

2. 项目的启动文件介绍

Obsidian Core Search Assistant 插件的启动文件主要是 manifest.json 和 src/ 目录下的主要代码文件。

`manifest.json`

manifest.json 文件包含了插件的基本信息，如插件的 ID、名称、版本、作者等。Obsidian 通过读取这个文件来加载和初始化插件。


{
  "id": "obsidian-core-search-assistant-plugin",
  "name": "Core Search Assistant",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "An Obsidian plugin to enhance built-in search: keyboard interface, card preview, bigger preview",
  "author": "qawatake",
  "authorUrl": "https://github.com/qawatake",
  "isDesktopOnly": false
}

`src/` 目录

src/ 目录包含了插件的主要源代码文件，其中可能包含插件的入口文件（如 main.ts 或 index.ts），这些文件负责插件的初始化和启动。

3. 项目的配置文件介绍

Obsidian Core Search Assistant 插件的配置文件主要包括 package.json 和 tsconfig.json。

`package.json`

package.json 文件包含了项目的依赖、脚本和其他配置信息。


{
  "name": "obsidian-core-search-assistant-plugin",
  "version": "1.0.0",
  "description": "An Obsidian plugin to enhance built-in search: keyboard interface, card preview, bigger preview",
  "main": "main.js",
  "scripts": {
    "dev": "node esbuild.config.mjs",
    "build": "node esbuild.config.mjs production"
  },
  "keywords": [
    "obsidian",
    "obsidian-plugin",
    "obsidian-md"
  ],
  "author": "qawatake",
  "license": "MIT",
  "devDependencies": {
    "esbuild": "^0.12.0",
    "typescript": "^4.3.0"
  }
}

`tsconfig.json`

tsconfig.json 文件包含了 TypeScript 的编译配置信息。


{
  "compilerOptions": {
    "target": "ESNext",
    "module": "CommonJS",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true
  },
  "include": [
    "src/**/*"
  ]
}

通过以上介绍，您可以更好地理解和使用 Obsidian Core Search Assistant 插件。

# 随笔