Obsidian Imgur 插件使用教程

Obsidian Imgur 插件使用教程

obsidian-imgur-pluginPastes images right to imgur.com项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-imgur-plugin

项目目录结构及介绍

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

obsidian-imgur-plugin/
├── .github/
│   └── workflows/
├── .obsidian/
│   └── plugins/
├── .gitignore
├── LICENSE
├── README.md
├── main.ts
├── manifest.json
├── styles.css
└── tsconfig.json

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• .obsidian/plugins/: 存放 Obsidian 插件的目录。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• main.ts: 插件的主入口文件。
• manifest.json: 插件的元数据文件。
• styles.css: 插件的样式文件。
• tsconfig.json: TypeScript 配置文件。

项目的启动文件介绍

main.ts 是 Obsidian Imgur 插件的主入口文件。它负责初始化插件并定义插件的主要功能。以下是 main.ts 的主要内容：

import { Plugin } from 'obsidian';
import { ImgurUploader } from './imgur';

export default class ImgurPlugin extends Plugin {
    async onload() {
        this.addCommand({
            id: 'upload-image',
            name: 'Upload Image to Imgur',
            callback: () => {
                new ImgurUploader(this).uploadImage();
            }
        });
    }
}

• Plugin: 导入 Obsidian 的插件基类。
• ImgurUploader: 导入 Imgur 上传器的类。
• ImgurPlugin: 定义插件类，继承自 Plugin。
• onload: 插件加载时调用的方法，注册上传图片的命令。

项目的配置文件介绍

manifest.json 是 Obsidian Imgur 插件的元数据文件，包含插件的基本信息和依赖项。以下是 manifest.json 的内容：

{
    "id": "obsidian-imgur-plugin",
    "name": "Imgur Plugin",
    "version": "1.0.0",
    "minAppVersion": "0.12.0",
    "description": "Upload images to Imgur instead of storing them locally.",
    "author": "gavvvr",
    "authorUrl": "https://github.com/gavvvr",
    "isDesktopOnly": false
}

• id: 插件的唯一标识符。
• name: 插件的名称。
• version: 插件的版本号。
• minAppVersion: 插件支持的最低 Obsidian 版本。
• description: 插件的描述。
• author: 插件的作者。
• authorUrl: 作者的 URL。
• isDesktopOnly: 是否仅支持桌面版 Obsidian。

以上是 Obsidian Imgur 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

obsidian-imgur-pluginPastes images right to imgur.com项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-imgur-plugin