Obsidian-Local-GPT 项目使用教程

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

Obsidian-Local-GPT 项目的目录结构如下：

obsidian-local-gpt/
├── src/
│   ├── editorconfig
│   ├── eslintignore
│   ├── eslintrc
│   ├── gitignore
│   ├── npmrc
│   ├── prettierignore
│   ├── LICENSE
│   ├── README.md
│   ├── esbuild.config.mjs
│   ├── manifest.json
│   ├── package-lock.json
│   ├── package.json
│   ├── styles.css
│   ├── tsconfig.json
│   ├── version-bump.mjs
│   └── versions.json

目录结构介绍

• src/: 包含项目的主要源代码文件。
  • editorconfig: 编辑器配置文件。
  • eslintignore: ESLint 忽略文件。
  • eslintrc: ESLint 配置文件。
  • gitignore: Git 忽略文件。
  • npmrc: npm 配置文件。
  • prettierignore: Prettier 忽略文件。
  • LICENSE: 项目许可证。
  • README.md: 项目说明文档。
  • esbuild.config.mjs: esbuild 配置文件。
  • manifest.json: 插件清单文件。
  • package-lock.json: npm 锁定文件。
  • package.json: npm 包配置文件。
  • styles.css: 样式文件。
  • tsconfig.json: TypeScript 配置文件。
  • version-bump.mjs: 版本更新脚本。
  • versions.json: 版本信息文件。

2. 项目的启动文件介绍

项目的启动文件主要是 esbuild.config.mjs 和 package.json。

esbuild.config.mjs

esbuild.config.mjs 是 esbuild 的配置文件，用于构建和打包项目。它定义了如何处理 JavaScript 和 TypeScript 文件，以及如何生成最终的输出文件。

package.json

package.json 是 npm 包的配置文件，包含了项目的依赖、脚本命令等信息。通过运行 npm install 可以安装项目所需的所有依赖，通过运行 npm run build 可以构建项目。

3. 项目的配置文件介绍

项目的配置文件主要包括 manifest.json 和 tsconfig.json。

manifest.json

manifest.json 是 Obsidian 插件的清单文件，包含了插件的基本信息、版本号、作者、依赖等。它是 Obsidian 识别和加载插件的关键文件。

tsconfig.json

tsconfig.json 是 TypeScript 的配置文件，定义了 TypeScript 编译器的选项和编译目标。它确保 TypeScript 代码能够正确编译成 JavaScript 代码。

以上是 Obsidian-Local-GPT 项目的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。