Obsidian Metatable 插件项目教程

Obsidian Metatable 插件项目教程

obsidian-metatable An Obsidian plugin to display the frontmatter section as a fully expanded table. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-metatable

1. 项目目录结构及介绍

Obsidian Metatable 插件项目的目录结构如下：

• .github/
  • 存储与 GitHub Actions 相关的配置文件。
• docs/
  • 存储项目文档。
• src/
  • 包含插件的源代码。
• support/
  • 存储辅助性文件或文档。
• .editorconfig
  • 定义代码编辑器的配置。
• .gitignore
  • 指定 Git 忽略的文件和目录。
• CHANGELOG.md
  • 记录项目的历史更新和修改。
• LICENCE
  • 项目的许可协议文件。
• README.md
  • 项目的介绍和说明文件。
• esbuild.config.mjs
  • esbuild 的配置文件。
• jest.config.js
  • Jest 测试框架的配置文件。
• manifest.json
  • 插件的配置文件。
• package-lock.json
  • npm 包的锁定文件。
• package.json
  • npm 包的配置文件。
• screenshot.png
  • 插件的屏幕截图。
• styles.css
  • 插件的样式文件。
• tsconfig.json
  • TypeScript 的配置文件。
• versions.json
  • 插件版本信息。

2. 项目的启动文件介绍

项目的主要启动文件是 src/ 目录下的 main.js 文件。这个文件负责初始化插件，并将其集成到 Obsidian 编辑器中。以下是 main.js 文件的基本内容：

// 引入所需的依赖
import { registerPlugin } from 'obsidian';

// 插件的主类
class MetatablePlugin {
  constructor(app) {
    this.app = app;
  }

  // 插件初始化函数
  async onload() {
    // 这里是初始化插件的代码
  }

  // 插件卸载函数
  onunload() {
    // 这里是清理插件的代码
  }
}

// 注册插件
registerPlugin({
  id: 'obsidian-metatable',
  name: 'Obsidian Metatable',
  main: function(app) {
    return new MetatablePlugin(app);
  }
});

3. 项目的配置文件介绍

项目的配置文件是 manifest.json，这个文件定义了插件的基本信息和配置选项。以下是 manifest.json 文件的基本内容：

{
  "id": "obsidian-metatable",
  "name": "Obsidian Metatable",
  "namespace": "obsidian-metatable",
  "version": "0.14.7",
  "description": "一个将 Obsidian 的 frontmatter 部分显示为扩展表格的插件。",
  "author": "Arnau Siches",
  "license": "MIT",
  "minAppVersion": "0.12.0",
  "main": "main.js",
  "icon": "metatable.png",
  "settings": {
    "default": {
      "showSidebar": true
    },
    "schema": [
      {
        "type": "switch",
        "id": "showSidebar",
        "name": "显示侧边栏",
        "description": "是否在侧边栏显示表格视图"
      }
    ]
  }
}

在这个配置文件中，定义了插件的 ID、名称、版本、描述、作者、许可协议、最小应用版本、主文件路径、图标以及插件设置。这些配置项会在 Obsidian 编辑器的插件市场中显示，并允许用户进行一些基本设置。

obsidian-metatable An Obsidian plugin to display the frontmatter section as a fully expanded table. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-metatable