Obsidian Garden 项目启动与配置教程

1. 项目目录结构及介绍

Obsidian Garden 是一个基于 Obsidian 的知识库插件。以下是项目的目录结构及各部分的简要介绍：

obsidian-garden/
├── .gitignore          # 忽略文件列表
├── assets/             # 存放静态资源，如图片等
├── manifest.json       # 插件元数据文件
├── package.json        # npm 包管理配置文件
├── plugin/             # 插件主目录
│   ├── index.js        # 插件入口文件
│   ├── main.js         # 插件主体逻辑
│   └── styles/         # 插件样式文件
└── test/               # 测试代码目录

• .gitignore：指定在执行 git 操作时应该忽略的文件和目录。
• assets/：存放项目所需的静态资源，如图片、图标等。
• manifest.json：定义插件的基本信息，如名称、描述、版本等。
• package.json：用于管理项目的 npm 包依赖。
• plugin/：插件的核心目录，包含了插件的主要逻辑和样式。
  • index.js：插件的入口文件，用于初始化插件。
  • main.js：插件的主要逻辑文件。
  • styles/：存放插件的样式文件。
• test/：存放测试代码，确保插件的功能正确。

2. 项目的启动文件介绍

在 obsidian-garden 项目中，启动文件是 plugin/index.js。该文件负责初始化插件并注册到 Obsidian 编辑器中。

// index.js

module.exports = (app) => {
    app.plugins.register({
        id: 'obsidian-garden',
        name: 'Obsidian Garden',
        // 其他配置和初始化代码
    });
};

该文件通过 app.plugins.register 方法注册插件，其中包含了插件的 ID、名称等基本信息。

3. 项目的配置文件介绍

obsidian-garden 项目的配置文件是 manifest.json。该文件定义了插件的基本信息和一些配置选项。

{
    "id": "obsidian-garden",
    "name": "Obsidian Garden",
    "version": "1.0.0",
    "description": "一个用于管理你的知识库的Obsidian插件",
    "author": "tanepiper",
    "minAppVersion": "0.12.0",
    "main": "plugin/index.js",
    "scripts": {
        "build": "webpack --mode production"
    },
    "dependencies": {
        "obsidian": "^0.12.0"
    },
    "contributes": {
        "configuration": {
            "type": "object",
            "title": "Obsidian Garden 设置",
            "properties": {
                "obsidian-gardenSetting": {
                    "type": "boolean",
                    "default": true,
                    "description": "是否启用 Obsidian Garden 功能"
                }
            }
        }
    }
}

在 manifest.json 文件中：

• id、name、version、description、author 等字段定义了插件的基本信息。
• main 字段指定了插件的入口文件。
• scripts 字段定义了构建脚本，这里使用 webpack 进行打包。
• dependencies 字段声明了项目依赖的 npm 包。
• contributes 字段中的 configuration 定义了插件的配置选项，用户可以在 Obsidian 的设置界面中修改这些配置。