Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aetherinox/obsidian-dataview-snippets

A collection of Obsidian.md scripts which include Tag & Page Clouds, Table of Contents / ToC, Bad / Missing Link reporting, etc.
https://github.com/aetherinox/obsidian-dataview-snippets

dataview obsidian obsidian-community obsidian-dataview obsidian-dataview-scripts obsidian-dataview-snippets obsidian-md obsidian-md-config obsidian-notes obsidian-plugin obsidian-plugins obsidian-snippet obsidian-snippets obsidian-template obsidian-vault obsidianmd

Last synced: 6 days ago
JSON representation

A collection of Obsidian.md scripts which include Tag & Page Clouds, Table of Contents / ToC, Bad / Missing Link reporting, etc.

Awesome Lists containing this project

README

        


Dataview Snippets

⭕ Obsidian Snippet Collection ⭕


A collection of dataview scripts which can be utilized within your Obsidian.md notes to perform various tasks and display data.




[![Version][github-version-img]][github-version-uri]
[![Build Status][github-build-img]][github-build-uri]
[![Downloads][github-downloads-img]][github-downloads-uri]
[![Size][github-size-img]][github-size-img]
[![Last Commit][github-commit-img]][github-commit-img]
[![Contributors][contribs-all-img]](#contributors-)


---


- [About](#about)
- [Snippets](#snippets)
- [Table of Contents: Version 1](#table-of-contents-version-1)
- [Table of Contents: Version 2](#table-of-contents-version-2)
- [Subfolder Data](#subfolder-data)
- [Bad Links: Version 1](#bad-links-version-1)
- [Tag Cloud: Version 1](#tag-cloud-version-1)
- [Tag Cloud: Version 2](#tag-cloud-version-2)
- [Page Cloud: Version 1](#page-cloud-version-1)
- [Alphabetized List: Version 1](#alphabetized-list-version-1)
- [Contributors ✨](#contributors-)


---


## About
This repo originally started a single **Table of Contents** script which displays at the top of your obsidian note. However, numerous other scripts have been added since then.

The snippets in this repo require you to download and install the following:
- [Obsidian.md](obsidian.md/)
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)


---


## Snippets
The following snippets are available in this repo


### Table of Contents: Version 1

The `Table of Contents: Version 1` snippet displays a table of contents. It compiles a list of all your folder's current subpages and pulls the headers from each page to display in a simple and neat list.


For this version, you will need to create a new **Folder Note** using the [Folder Notes Plugin](https://github.com/LostPaul/obsidian-folder-notes), and then paste the provided code at the top of the new folder note.


This version requires you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)
- [Folder Notes Plugin](https://github.com/LostPaul/obsidian-folder-notes)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/TOC%20Version%201)



---



### Table of Contents: Version 2

The `Table of Contents: Version 2` snippet displays a table of contents. It compiles a list of all your folder's current subpages and pulls the headers from each page to display in a simple and neat list.


To use this snippet, paste the provided table of contents code at the top of a regular Obsidian note. It will fetch all of the headers which exist on that same page and display them in an unordered list at the top.


This version requires you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/TOC%20Version%202)



---



### Subfolder Data

The `Subfolder Data` snippet displays a table of contents listing based on a specified subfolder. This is useful if you want to pull a list of headers which exist on a page that is not associated to the current folder you are working in.

The other snippets above also support subpages, but this one is a bit more customized for subfolder management.


This version **requires** you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)

The following plugins are **optional**:
- [Folder Notes Plugin](https://github.com/LostPaul/obsidian-folder-notes)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/Subfolder%20Data)



---



### Bad Links: Version 1

The `Bad Links: Version 1` snippet displays a list of internal links within your vault that lead nowhere (are broken).

To fix these, you can delete the link on the associated page, or you can click each item in the list and create a new page. Once the link has been fixed, it will be removed from the list.


This version **requires** you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/Bad%20Links%201)



---



### Tag Cloud: Version 1

The `Tag Cloud: Version 1` snippet fetches a list of tags associated to your vault and displays them in a series of columns.

Each tag can be clicked on, which will open the Search interface and display all other pages associated to the selected tag.

The functionality of `Version 1` and `Version 2` are the same. Both just have difference appearances.


This version **requires** you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/Tag%20Cloud%201)



---



### Tag Cloud: Version 2

The `Tag Cloud: Version 2` snippet fetches a list of tags associated to your vault and displays them in a series of columns.

Each tag can be clicked on, which will open the Search interface and display all other pages associated to the selected tag.

The functionality of `Version 1` and `Version 2` are the same. Both just have difference appearances.


This version **requires** you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/Tag%20Cloud%202)



---



### Page Cloud: Version 1

The `Page Cloud: Version 1` snippet fetches a list of pages within your vault and displays them in a cloud structure.

Each page can be clicked on which will re-direct you to that particular page. Page titles also support the frontmatter values:
- name
- title
- alias

The functionality of `Version 1` and `Version 2` are the same. Both just have difference appearances.


This version **requires** you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/Page%20Cloud%201)



---



### Alphabetized List: Version 1

The `Alphabetized List: Version 1` snippet fetches a list of pages within your vault and displays them in a alphabetized list.

Each page can be clicked on which will re-direct you to that particular page. Page titles also support the frontmatter values:
- name
- title
- alias


This version **requires** you to install the following:
- [Dataview Plugin](https://github.com/blacksmithgu/obsidian-dataview)


[![View](https://img.shields.io/badge/%20-%20View%20Readme-%20%23de2343?style=for-the-badge&logo=github&logoColor=FFFFFF)](https://github.com/Aetherinox/obsidian-dataview-snippets/tree/main/Snippets/Alphabetized%20List%201)


---


## Contributors ✨
We are always looking for contributors. If you feel that you can provide something useful to Gistr, then we'd love to review your suggestion. Before submitting your contribution, please review the following resources:

- [Pull Request Procedure](.github/PULL_REQUEST_TEMPLATE.md)
- [Contributor Policy](CONTRIBUTING.md)


Want to help but can't write code?
- Review [active questions by our community](https://github.com/Aetherinox/obsidian-dataview-snippets/labels/help%20wanted) and answer the ones you know.


The following people have helped get this project going:


[![Contributors][contribs-all-img]](#contributors-)



Aetherinox
Aetherinox

💻 📆 🔍




[general-npmjs-uri]: https://npmjs.com
[general-nodejs-uri]: https://nodejs.org
[general-npmtrends-uri]: http://npmtrends.com/obsidian-dataview-snippets

[github-version-img]: https://img.shields.io/github/v/tag/Aetherinox/obsidian-dataview-snippets?logo=GitHub&label=Version&color=ba5225
[github-version-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases

[npm-version-img]: https://img.shields.io/npm/v/obsidian-dataview-snippets?logo=npm&label=Version&color=ba5225
[npm-version-uri]: https://npmjs.com/package/obsidian-dataview-snippets

[pypi-version-img]: https://img.shields.io/pypi/v/obsidian-dataview-snippets-plugin
[pypi-version-uri]: https://pypi.org/project/obsidian-dataview-snippets-plugin/

[license-mit-img]: https://img.shields.io/badge/MIT-FFF?logo=creativecommons&logoColor=FFFFFF&label=License&color=9d29a0
[license-mit-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/blob/main/LICENSE

[github-downloads-img]: https://img.shields.io/github/downloads/Aetherinox/obsidian-dataview-snippets/total?logo=github&logoColor=FFFFFF&label=Downloads&color=376892
[github-downloads-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases

[npmjs-downloads-img]: https://img.shields.io/npm/dw/%40aetherinox%2Fmkdocs-link-embeds?logo=npm&&label=Downloads&color=376892
[npmjs-downloads-uri]: https://npmjs.com/package/obsidian-dataview-snippets

[github-size-img]: https://img.shields.io/github/repo-size/Aetherinox/obsidian-dataview-snippets?logo=github&label=Size&color=59702a
[github-size-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/releases

[npmjs-size-img]: https://img.shields.io/npm/unpacked-size/obsidian-dataview-snippets/latest?logo=npm&label=Size&color=59702a
[npmjs-size-uri]: https://npmjs.com/package/obsidian-dataview-snippets

[codecov-coverage-img]: https://img.shields.io/codecov/c/github/Aetherinox/obsidian-dataview-snippets?token=MPAVASGIOG&logo=codecov&logoColor=FFFFFF&label=Coverage&color=354b9e
[codecov-coverage-uri]: https://codecov.io/github/Aetherinox/obsidian-dataview-snippets

[contribs-all-img]: https://img.shields.io/github/all-contributors/Aetherinox/obsidian-dataview-snippets?logo=contributorcovenant&color=de1f6f&label=contributors
[contribs-all-uri]: https://github.com/all-contributors/all-contributors

[github-build-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
[github-build-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/release.yml

[github-build-pypi-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/release-pypi.yml?logo=github&logoColor=FFFFFF&label=Build&color=%23278b30
[github-build-pypi-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/pypi-release.yml

[github-tests-img]: https://img.shields.io/github/actions/workflow/status/Aetherinox/obsidian-dataview-snippets/npm-tests.yml?logo=github&label=Tests&color=2c6488
[github-tests-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/actions/workflows/npm-tests.yml

[github-commit-img]: https://img.shields.io/github/last-commit/Aetherinox/obsidian-dataview-snippets?logo=conventionalcommits&logoColor=FFFFFF&label=Last%20Commit&color=313131
[github-commit-uri]: https://github.com/Aetherinox/obsidian-dataview-snippets/commits/main/