Database Folder Plugin 技术文档

Database Folder Plugin 技术文档

obsidian-db-folder Obsidian Plugin to Allow Notion like database based on folders 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-db-folder

1. 安装指南

1.1 安装前准备

在安装 Database Folder Plugin 之前，请确保您已经安装了以下依赖插件：

• Dataview: 该插件用于搜索和索引 Markdown 文件中的数据。

1.2 安装步骤

1. 打开 Obsidian 应用。
2. 进入“社区插件”选项卡。
3. 搜索 Database Folder Plugin。
4. 点击“安装”按钮进行安装。
5. 安装完成后，点击“启用”按钮启用插件。

2. 项目使用说明

2.1 创建数据库

您可以通过以下三种方式创建数据库：

• 命令方式: 使用命令 DB folder: create a new database table。
• 侧边栏图标: 点击自定义侧边栏图标。
• 手动创建: 在 Obsidian 中手动创建一个文件夹，并在其中添加 Markdown 文件。

2.2 数据库视图

数据库视图将根据您指定的源（文件夹、标签、链接或 Dataview 查询）搜索所有笔记，并显示您指定的列/元数据。您可以在 文档 中找到更多信息。

2.3 数据编辑

在数据库视图中添加或编辑的信息将直接保存到目标 Obsidian 笔记中。

3. 项目 API 使用文档

3.1 Dataview API

Dataview 插件提供了强大的数据索引和查询功能。您可以使用 Dataview 的 API 来查询和操作 Markdown 文件中的数据。

3.2 React UI API

• React-Table: 用于构建强大的表格和数据网格。
• React-Select: 用于创建可编辑的下拉选择框。
• Notion Style Base: 提供了 Notion 风格的 UI 组件。

4. 项目安装方式

4.1 通过 Obsidian 社区插件安装

如前所述，您可以通过 Obsidian 的社区插件市场直接安装 Database Folder Plugin。

4.2 手动安装

1. 从 GitHub 仓库 下载最新版本的插件。
2. 将下载的插件文件解压到 Obsidian 的插件目录中。
3. 在 Obsidian 中启用插件。

通过以上步骤，您可以顺利安装并使用 Database Folder Plugin，享受在 Obsidian 中创建和管理数据库的便捷体验。

obsidian-db-folder Obsidian Plugin to Allow Notion like database based on folders 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-db-folder