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

1. 项目目录结构及介绍

Obsidian Dataview 的源代码目录通常有以下结构：

- obsidian-dataview/
  ├── docs/           # 文档资料目录
  ├── src/             # 源代码目录
    ├── index.ts       # 主入口文件
    └── ...             # 其他相关源码文件
  ├── package.json     # 项目依赖和脚本定义
  ├── README.md        # 项目说明文档
  └── scripts/         # 脚本工具目录
    └── install-built  # 安装到特定知识库的脚本
  ...

• docs/: 包含项目的文档和 MkDocs 配置，用于构建和展示项目的用户手册。
• src/: 代码主体，包括主要功能实现和 API。
• package.json: 项目元数据和npm包依赖，还包含了运行时或构建时使用的脚本。
• README.md: 项目的简要介绍和指南。
• scripts/: 提供一些辅助脚本，例如安装已编译的插件到你的 Obsidian 知识库。

2. 项目的启动文件介绍

主要的启动文件是 src/index.ts，它定义了插件的核心逻辑和API。在开发过程中，你可以通过运行 npm run dev 来启动一个监听模式，这将编译代码并部署到测试知识库中。当你修改代码时，rollup 会自动重新编译，测试知识库也会自动刷新。

3. 项目的配置文件介绍

该项目没有专门的配置文件，但配置可以通过 package.json 文件中的 scripts 部分进行。例如，你可以看到命令像 npm run build 和 npm run dev，这些是用于构建和开发环境的。

• npm run build: 执行一次性的代码构建，生成可用于安装到其他知识库的版本。
• npm run dev: 启动开发服务器，监视代码变更并自动重新加载测试知识库。

此外，如果你想要自定义安装或者调整插件的行为，可能需要根据 scripts/install-built 脚本来修改路径或参数。

注意事项

在安装到真实知识库前，请确保已经备份数据，因为虽然 Dataview 主要是读取操作，但在开发调整时对文件编辑的功能可能会造成影响。

安装完成后，你可以在 Obsidian 中查看和使用 Dataview 插件提供的功能。要更新文档或进一步定制插件，可以参考文档目录下的 mkdocs 相关文件和 pip3 安装的依赖来更新文档页面。

本文档是一个基本的引导，详细的开发和使用指南可以在项目官方仓库的 README.md 或者 docs 目录下找到。

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