Obsidian Homepage 插件项目教程

Obsidian Homepage 插件项目教程

obsidian-homepage An Obsidian plugin that opens a specified note, canvas, or workspace on startup, instead of the most recent one. 项目地址: https://gitcode.com/gh_mirrors/obsi/obsidian-homepage

1. 项目目录结构及介绍

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

• .github/：存放与 GitHub 相关的配置文件。
• src/：源代码目录，包含了插件的主要逻辑。
• tests/：测试代码目录，用于保证插件功能的正确性。
• .gitignore：Git 忽略文件，指定 Git 应该忽略的文件和目录。
• LICENSE.md：许可证文件，本项目采用 MIT 许可。
• README.md：项目说明文件，介绍了插件的功能和用法。
• build.mjs：构建脚本，用于编译和打包插件。
• manifest.json：插件的配置文件，定义了插件的元数据和功能。
• package.json：Node.js 项目配置文件，定义了项目的依赖和脚本。
• styles.css：样式文件，定义了插件的用户界面样式。
• tsconfig.json：TypeScript 配置文件，用于配置 TypeScript 编译器。
• versions.json：版本信息文件，记录了插件的版本历史。

2. 项目的启动文件介绍

项目的启动主要是通过 manifest.json 文件来实现的。该文件包含了插件的名称、版本、描述等元数据，以及插件的主入口文件。

{
  "name": "obsidian-homepage",
  "version": "4.2",
  "description": "An Obsidian plugin that opens a specified note, canvas, or workspace on startup, instead of the most recent one.",
  "main": "dist/index.js",
  "author": "mirnovov",
  "license": "MIT",
  "scripts": {
    "build": "tsc && rollup -c"
  },
  "dependencies": {
    // 依赖列表
  },
  "devDependencies": {
    // 开发依赖列表
  }
}

在 manifest.json 中，"main": "dist/index.js" 指定了插件的主入口文件，该文件是编译后的 JavaScript 文件。

3. 项目的配置文件介绍

项目的配置主要通过 manifest.json 和 tsconfig.json 两个文件进行。

• manifest.json：如前所述，该文件包含了插件的元数据和启动配置。此外，它还定义了插件的命令和菜单项，以便用户在 Obsidian 中使用。

• tsconfig.json：TypeScript 配置文件，用于指定 TypeScript 编译器的行为。以下是该文件的基本内容：

{
  "compilerOptions": {
    "target": "es5",
    "module": "commonjs",
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["src"],
  "exclude": ["node_modules"]
}

在这个配置文件中，"target": "es5" 指定了编译后的 JavaScript 目标版本，"module": "commonjs" 指定了生成的模块系统。"include" 和 "exclude" 字段用于指定哪些文件应该被编译和哪些文件应该被排除在外。

obsidian-homepage An Obsidian plugin that opens a specified note, canvas, or workspace on startup, instead of the most recent one. 项目地址: https://gitcode.com/gh_mirrors/obsi/obsidian-homepage