Obsidian Language Learner 插件使用教程

Obsidian Language Learner 插件使用教程

obsidian-language-learner项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-language-learner

项目目录结构及介绍

Obsidian Language Learner 插件的目录结构如下：

obsidian-language-learner/
├── src/
│   ├── editorconfig
│   ├── eslintignore
│   ├── eslintrc
│   ├── gitignore
│   ├── npmrc
│   ├── LICENSE
│   ├── README.md
│   ├── esbuild.config.mjs
│   ├── manifest.json
│   ├── package-lock.json
│   ├── package.json
│   ├── publish.mjs
│   ├── shims.d.ts
│   ├── styles.css
│   ├── tsconfig.json
│   ├── version-bump.mjs
│   └── versions.json
├── public/
└── ...

目录结构说明

• src/：包含插件的主要源代码文件。
  • editorconfig：编辑器配置文件。
  • eslintignore：ESLint 忽略配置文件。
  • eslintrc：ESLint 配置文件。
  • gitignore：Git 忽略配置文件。
  • npmrc：NPM 配置文件。
  • LICENSE：项目许可证。
  • README.md：项目说明文档。
  • esbuild.config.mjs：esbuild 配置文件。
  • manifest.json：插件的 manifest 文件，包含插件的基本信息。
  • package-lock.json：NPM 锁定文件。
  • package.json：NPM 包配置文件。
  • publish.mjs：发布脚本文件。
  • shims.d.ts：TypeScript 类型声明文件。
  • styles.css：CSS 样式文件。
  • tsconfig.json：TypeScript 配置文件。
  • version-bump.mjs：版本更新脚本文件。
  • versions.json：版本信息文件。
• public/：公共资源文件夹。

项目启动文件介绍

项目的启动文件主要是 src/publish.mjs 和 src/version-bump.mjs。

• publish.mjs：用于发布插件的脚本文件。
• version-bump.mjs：用于更新插件版本的脚本文件。

项目的配置文件介绍

项目的配置文件主要包括以下几个：

• src/manifest.json：插件的 manifest 文件，包含插件的基本信息，如名称、版本、作者等。
• src/package.json：NPM 包配置文件，包含项目的依赖、脚本命令等。
• src/tsconfig.json：TypeScript 配置文件，包含 TypeScript 编译选项。
• src/esbuild.config.mjs：esbuild 配置文件，用于构建和打包插件。

这些配置文件共同确保了插件的正确开发、构建和发布。

obsidian-language-learner项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-language-learner