Obsidian Ink 插件安装与使用教程

1. 项目目录结构及介绍

Obsidian Ink 插件的目录结构如下：

obsidian_ink/
├── .github/
├── coverage/
├── docs/
│   └── media/
├── scripts/
├── src/
│   ├── .editorconfig
│   ├── .eslintrc
│   ├── .gitignore
│   ├── babel.config.js
│   ├── esbuild.config.mjs
│   ├── jest.config.ts
│   ├── manifest-beta.json
│   ├── manifest.json
│   ├── package-lock.json
│   ├── package.json
│   ├── tsconfig.json
│   ├── version-bump.mjs
│   └── versions.json
├── LICENSE.md
└── README.md

• .github/：包含 GitHub 使用的配置文件。
• coverage/：用于存放代码测试覆盖率报告。
• docs/：存放文档及相关媒体文件。
• media/：文档中使用的媒体文件，如图像、视频等。
• scripts/：包含项目构建和部署的脚本文件。
• src/：源代码目录，包含插件的主要逻辑。
• .editorconfig、.eslintrc、.gitignore、babel.config.js、esbuild.config.mjs、jest.config.ts、tsconfig.json：项目配置文件。
• manifest-beta.json、manifest.json：插件配置文件，用于定义插件的行为和界面。
• package-lock.json、package.json：npm 包管理配置文件。
• version-bump.mjs、versions.json：用于版本管理的文件。
• LICENSE.md：项目许可证文件。
• README.md：项目说明文件。

2. 项目的启动文件介绍

项目的启动主要依赖于 manifest.json 文件，该文件定义了插件的元数据和启动时加载的脚本。以下是 manifest.json 的基本结构：

{
  "name": "Obsidian Ink",
  "id": "obsidian-ink",
  "main": "main.js",
  "icon": "icon.png",
  "description": "A plugin for Obsidian that adds the ability to hand write or draw with a stylus between paragraphs in your notes.",
  // 其他配置...
}

在这里，main 字段指定了插件的启动文件 main.js，该文件负责初始化插件并注册所需的功能。

3. 项目的配置文件介绍

项目的配置文件主要包括 config.json 和 manifest.json。

• config.json：用于存储插件的配置数据，例如用户自定义的设置。该文件通常在插件首次运行时创建，并根据用户的操作更新。

{
  // 用户配置数据...
}

• manifest.json：如前所述，该文件定义了插件的元数据和启动时加载的脚本。此外，它还包含了插件的权限声明、菜单项和其他界面元素的配置。

{
  "name": "Obsidian Ink",
  "id": "obsidian-ink",
  "main": "main.js",
  "icon": "icon.png",
  "description": "A plugin for Obsidian that adds the ability to hand write or draw with a stylus between paragraphs in your notes.",
  "permissions": ["activeTab", "storage", "scripting"],
  "action": {
    "default_popup": "popup.html",
    "default_icon": {
      "16": "images/icon16.png",
      "48": "images/icon48.png",
      "128": "images/icon128.png"
    }
  },
  // 其他配置...
}

在 manifest.json 中，permissions 字段声明了插件所需的权限，action 字段定义了插件在工具栏上的图标和点击时弹出的界面。这些配置确保了插件能够在 Obsidian 中正常运行并提供所需的功能。