Obsidian Dataview 使用教程

Obsidian Dataview 使用教程

obsidian-dataviewA high-performance data index and query language over Markdown files, for https://obsidian.md/.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-dataview

项目介绍

Obsidian Dataview 是一个用于 Obsidian 笔记应用的数据索引和查询引擎。它允许用户在 Markdown 文件中添加元数据，并使用 Dataview 查询语言（DQL）对这些数据进行查询、过滤、排序和分组。Dataview 使得数据聚合变得简单，并且保持查询始终是最新的。

项目快速启动

安装和构建

1. 克隆仓库：

   git clone git@github.com:blacksmithgu/obsidian-dataview.git
   

2. 进入项目目录：

   cd obsidian-dataview
   

3. 安装依赖：

   npm install
   

4. 运行开发模式：

   npm run dev
   

这将安装库、构建 Dataview，并将其部署到 test-vault，您可以在 Obsidian 中打开它。同时，Rollup 会进入监视模式，任何代码更改都会重新编译，测试库会自动重新加载。

安装到其他库

如果您想在实际库中使用 Dataview，可以手动构建和安装：

npm run build

应用案例和最佳实践

应用案例

1. 跟踪睡眠：在每日笔记中记录睡眠情况，自动创建每周睡眠时间表。
2. 收集书籍链接：在笔记中收集书籍链接，并按评分排序显示。
3. 动态视图：创建动态视图，显示即将到来的生日或事件。

最佳实践

• 保持元数据一致性：确保所有笔记中的元数据格式一致，以便查询时不会出现错误。
• 使用模板：创建模板以便快速添加新的笔记和元数据。
• 定期更新查询：随着笔记数量的增加，定期检查和更新查询以确保性能。

典型生态项目

MkDocs 文档构建

Obsidian Dataview 使用 MkDocs 构建文档。您需要 Python 和 pip 来本地运行它：

1. 安装 MkDocs 和相关插件：

   pip3 install mkdocs mkdocs-material mkdocs-redirects
   

2. 启动本地服务器：

   cd docs
   mkdocs serve
   

这将启动一个本地 Web 服务器，渲染 docs/docs 中的文档，并在更改时自动重新加载。

TypeScript 类型定义

Dataview 在 NPM 上发布了所有 API 的 TypeScript 类型定义（blacksmithgu/obsidian-dataview）。您可以按照以下步骤设置开发环境：

1. 安装类型定义：

   npm install @types/blacksmithgu__obsidian-dataview
   

2. 配置开发环境： 按照官方文档设置 TypeScript 开发环境。

通过这些步骤，您可以充分利用 Obsidian Dataview 的功能，并将其集成到您的笔记工作流中。

obsidian-dataviewA high-performance data index and query language over Markdown files, for https://obsidian.md/.项目地址:https://gitcode.com/gh_mirrors/ob/obsidian-dataview