Obsidian Mind Map 开源项目教程

Obsidian Mind Map 开源项目教程

项目的目录结构及介绍

Obsidian Mind Map 项目的目录结构如下：

obsidian-mind-map/
├── .github/
│   └── workflows/
│       └── main.yml
├── .obsidian/
│   └── plugins/
│       └── obsidian-mind-map/
│           ├── main.js
│           ├── manifest.json
│           └── styles.css
├── .gitignore
├── LICENSE
├── README.md
└── package.json

目录结构介绍

• .github/workflows/main.yml: GitHub Actions 的工作流配置文件，用于自动化构建和部署。
• .obsidian/plugins/obsidian-mind-map/: Obsidian 插件的核心文件夹，包含插件的主要代码和资源。
  • main.js: 插件的主入口文件。
  • manifest.json: 插件的清单文件，包含插件的元数据。
  • styles.css: 插件的样式文件。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目的开源许可证。
• README.md: 项目的说明文档。
• package.json: Node.js 项目的配置文件，包含项目的依赖和脚本。

项目的启动文件介绍

项目的启动文件是 .obsidian/plugins/obsidian-mind-map/main.js。这个文件是插件的入口点，负责初始化插件并注册必要的功能。

启动文件内容概览

// main.js
module.exports = (plugin) => {
  // 初始化插件
  plugin.register(() => {
    // 注册插件功能
  });
};

项目的配置文件介绍

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

1. manifest.json: 插件的清单文件，包含插件的元数据，如名称、版本、作者等。

{
  "id": "obsidian-mind-map",
  "name": "Mind Map",
  "version": "1.0.0",
  "minAppVersion": "0.12.0",
  "description": "A plugin for creating mind maps in Obsidian.",
  "author": "Lynch James",
  "authorUrl": "https://github.com/lynchjames",
  "isDesktopOnly": false
}

2. package.json: Node.js 项目的配置文件，包含项目的依赖和脚本。

{
  "name": "obsidian-mind-map",
  "version": "1.0.0",
  "description": "A plugin for creating mind maps in Obsidian.",
  "main": "main.js",
  "scripts": {
    "dev": "node build.js",
    "build": "node build.js"
  },
  "keywords": [
    "obsidian",
    "mind-map"
  ],
  "author": "Lynch James",
  "license": "MIT",
  "dependencies": {
    "obsidian": "^0.12.0"
  }
}

通过以上内容，您可以了解 Obsidian Mind Map 项目的目录结构、启动文件和配置文件的基本信息。希望这份教程对您有所帮助。