Obsidian Various Complements Plugin 使用教程

Obsidian Various Complements Plugin 使用教程

obsidian-various-complements-plugin This plugin for Obsidian enables you complete words like the auto-completion of IDE. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-various-complements-plugin

1. 项目目录结构及介绍

obsidian-various-complements-plugin/
├── .github/
│   └── workflows/
├── .husky/
├── src/
├── .gitignore
├── .mise.toml
├── .npmrc
├── .prettierrc.json
├── LICENSE
├── Makefile
├── README.md
├── esbuild.config.mjs
├── jest.config.js
├── manifest-beta.json
├── manifest.json
├── package.json
├── pnpm-lock.yaml
├── pull_request_template.md
├── styles.css
├── tsconfig.json
├── version-bump.mjs
└── versions.json

目录结构介绍

• .github/workflows/: 包含GitHub Actions的工作流配置文件。
• .husky/: 包含Husky的配置文件，用于Git钩子。
• src/: 包含项目的源代码。
• .gitignore: 指定Git忽略的文件和目录。
• .mise.toml: 可能是项目配置文件，具体用途需要查看文档。
• .npmrc: npm配置文件。
• .prettierrc.json: Prettier代码格式化配置文件。
• LICENSE: 项目许可证文件。
• Makefile: Makefile文件，用于构建和测试项目。
• README.md: 项目说明文档。
• esbuild.config.mjs: esbuild配置文件。
• jest.config.js: Jest测试框架配置文件。
• manifest-beta.json: 可能是插件的Beta版本配置文件。
• manifest.json: 插件的配置文件。
• package.json: npm包配置文件，包含项目的依赖和脚本。
• pnpm-lock.yaml: pnpm的锁定文件，用于确保依赖版本一致。
• pull_request_template.md: Pull Request模板文件。
• styles.css: 样式文件。
• tsconfig.json: TypeScript配置文件。
• version-bump.mjs: 可能是用于版本更新的脚本。
• versions.json: 可能是版本信息文件。

2. 项目启动文件介绍

项目的启动文件主要是src/目录下的源代码文件。具体启动逻辑需要查看src/目录下的入口文件，通常是main.ts或类似的文件。

3. 项目的配置文件介绍

3.1 manifest.json

manifest.json是Obsidian插件的核心配置文件，包含插件的基本信息和配置选项。

{
  "id": "obsidian-various-complements-plugin",
  "name": "Various Complements",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "This plugin for Obsidian enables you complete words like the auto-completion of IDE.",
  "author": "tadashi-aikawa",
  "authorUrl": "https://github.com/tadashi-aikawa",
  "isDesktopOnly": false
}

3.2 package.json

package.json是npm包配置文件，包含项目的依赖、脚本和元数据。

{
  "name": "obsidian-various-complements-plugin",
  "version": "1.0.0",
  "description": "This plugin for Obsidian enables you complete words like the auto-completion of IDE.",
  "main": "main.js",
  "scripts": {
    "dev": "node esbuild.config.mjs",
    "build": "node esbuild.config.mjs production",
    "test": "jest"
  },
  "author": "tadashi-aikawa",
  "license": "MIT",
  "dependencies": {
    "obsidian": "^0.12.0"
  },
  "devDependencies": {
    "esbuild": "^0.12.0",
    "jest": "^27.0.0"
  }
}

3.3 tsconfig.json

tsconfig.json是TypeScript的配置文件，定义了TypeScript编译器的选项。

{
  "compilerOptions": {
    "target": "ES2018",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true,
    "outDir": "dist"
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules", "dist"]
}

通过以上配置文件，可以了解项目的依赖、编译选项和插件的基本信息。

obsidian-various-complements-plugin This plugin for Obsidian enables you complete words like the auto-completion of IDE. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-various-complements-plugin