Logseq Plugin Excalidraw 项目启动与配置教程

1. 项目目录结构及介绍

logseq-plugin-excalidraw 项目目录结构如下：

logseq-plugin-excalidraw/
├── .gitignore           # Git 忽略文件配置
├── README.md            # 项目说明文件
├── package-lock.json    # 依赖包锁定文件
├── package.json         # 项目配置文件
├── public/              # 公共资源目录
│   └── ...              # 公共资源文件
├── src/                 # 源代码目录
│   ├── assets/          # 资源文件目录
│   ├── components/      # 组件目录
│   ├── hooks/           # 钩子函数目录
│   ├── index.js         # 入口文件
│   ├── logseq/          # Logseq 相关代码目录
│   ├── store/           # 状态管理目录
│   ├── styles/          # 样式文件目录
│   └── ...              # 其他源代码文件
└── ...                  # 其他文件或目录

以下是目录的简要介绍：

• .gitignore：指定 Git 忽略的文件和目录。
• README.md：项目说明文件，包含项目介绍、安装、使用方法和贡献指南等。
• package-lock.json：锁定项目的依赖包版本，确保在不同环境中构建一致性。
• package.json：项目配置文件，包含项目名称、版本、描述、依赖等。
• public/：存放公共资源，如图片、样式表、脚本等。
• src/：源代码目录，包含项目的主要代码。

2. 项目启动文件介绍

项目的启动文件位于 src/index.js。以下是启动文件的简要介绍：

// 引入 Logseq 插件相关代码
import { definePlugin } from '@logseq/libs'

// 定义插件
export default definePlugin((main) => {
  // 插件初始化逻辑
  mainbineAppEvent('海事', () => {
    // 执行相关操作
  })
})

在 index.js 文件中，首先引入了 Logseq 提供的 definePlugin 函数，然后使用该函数定义了一个插件。插件初始化时，通过 mainbineAppEvent 监听特定事件，并执行相关操作。

3. 项目的配置文件介绍

项目的配置文件位于 package.json。以下是配置文件的简要介绍：

{
  "name": "logseq-plugin-excalidraw",
  "version": "1.0.0",
  "description": "A Logseq plugin for Excalidraw",
  "main": "index.js",
  "scripts": {
    "start": "logseq-plugin development",
    "build": "logseq-plugin build"
  },
  "dependencies": {
    "@logseq/libs": "^0.1.0"
  },
  "devDependencies": {
    // 开发依赖
  }
}

在 package.json 文件中：

• "name" 和 "version" 定义了项目的名称和版本。
• "description" 提供了项目的描述信息。
• "main" 指定了项目的入口文件。
• "scripts" 定义了项目的脚本命令，包括启动开发和构建生产环境的命令。
• "dependencies" 列出了项目依赖的库。
• "devDependencies" 列出了项目的开发依赖库。