Vault Stats

by Blue Heron
5
4
3
2
1
Score: 51/100

Description

The Vault Stats plugin adds simple but powerful functions that let you see an overview of your entire vault at a glance. It provides two global calls - one to generate a markdown summary of note counts, word counts, links, and tags, and another to list the most recently modified notes, with the option to skip certain folders like Templates. These functions are designed for use with DataviewJS or custom scripts, making it easy to weave live stats into dashboards, reports, or daily notes.

Reviews

No reviews yet.

Stats

3
stars
1,000
downloads
0
forks
278
days
277
days
306
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

10 months ago

Changelog

The first working version! Includes two functions:

  • window.showStats: Shows overall stats (number of notes, total words, tags per note, etc.)
  • window.showRecentNotes`: Shows the top ten recently-modified notes (you can pass in parameters to change the count + exclusions)

README file from

Github

Vault Stats Plugin for Obsidian

A simple Obsidian plugin that exposes two handy global functions for vault statistics, which you can call from DataviewJS or other scripts:

  • showStats(): Returns markdown summary of vault note count, word count, links, and tags.
  • showLastModifiedNotes(numItems = 10, excludeFolder = "Templates"): Returns markdown list of the most recently modified notes, excluding an optional folder.

Installation

You can grab it from the Obsidian app, Community Plugins section.

  1. Clone or download this repo.

  2. Build the plugin with npm install and npm run build.

  3. Copy the resulting main.js, manifest.json, and optionally styles.css to your vault plugin folder: /.obsidian/plugins/vault-stats/

  4. Enable the plugin in Obsidian's Community Plugins settings.

Usage

Inside any note, create a DataviewJS block like this:

// Show general vault stats
let s = await window.showStats();
dv.paragraph(s);

// Show last modified notes (default 10, excluding "Templates" folder)
let recent = await window.showLastModifiedNotes(10, "Templates");
dv.paragraph("### 🕒 Last Modified Notes:\n\n" + recent);

You can customize numItems and excludeFolder arguments for showLastModifiedNotes.

Development

The main plugin code is in main.ts.

Build with npm run build.

For development, use npm run dev to watch and rebuild on changes.

License

MIT License — feel free to use and modify.

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.
Better Word Count
5 years ago by Luke Leppan
Counts the words of selected text in the editor.
Novel Word Count
4 years ago by Isaac Lyman
Obsidian plugin. Displays a word count or other statistic for each file, folder and vault in the File Explorer pane.
Reading Time
6 years ago by avr
Chronology
4 years ago by Gabriele Cannata
Writing Goals
3 years ago by James Lynch
Set yourself dynamic writing goals for notes and folders to help you hit your long form writing targets with Obsidian.
Daily Stats
5 years ago by Dhruvik Parikh
Plugin to view your daily word count across all notes in your Obsidian.md vault.
File Info Panel
4 years ago by CattailNu
This plugin for Obsidian creates a small File Info view that displays the active file's date created, date modified, file size, and links to open the file in its native application and to open the file's folder.
Keep the Rhythm
a year ago by Ezben
An Obsidian plugin to track your daily word count through a heatmap.
Recent Notes
a year ago by Kamil Rudnicki
Recent Notes Plugin for Obsidian
Last Modified Timestamp in Status Bar
3 years ago by Yustynn
Startpage
8 months ago by kuzzh
A modern startup homepage plugin for Obsidian that provides a beautiful dashboard interface, displaying vault statistics, pinned notes, and recent notes.
Wordflow Tracker
a year ago by LeCheenaX
Track the changes and stats of your edited note files automatically in Obsidian. Record the modified notes and statistics to your daily note with various customizations!
Daily Statistics
2 years ago by yefengr
obsidian daily statistics
Beeminder Word Count
5 years ago by Yuta Miyama
Beeminder integration with Obsidian, so that your word count in Obsidian contributes to your writing goals.
YourPulse - Your Writing Activity Visualised
a year ago by Jiri Sifalda
YourPulse.cc - Obsidian.md plugin that turns your vault into a reflection of your creativity, and put your writing on steroids 💪
Learnie
2 years ago by tankh99
Learnie is an Obsidian plugin that helps to enhance your learning with active recall and spaced repetition.
Focus Time
a year ago by AstraDev
Focus Time is a plugin that helps you track how much time you spend on each note.
RPG Stat Tracker
2 years ago by Cunjur
RPG-like stat tracker for Obsidian.
Sentinel
a year ago by Giorgos Sarigiannidis
A plugin for Obsidian that allows you to update properties or run commands based on document visibility changes.
Target Word Count
2 years ago by TwoFive Labs
Target Word Count Plugin for Obsidian
Custom Selected Word Count
a year ago by banisterious
Custom Selected Word Count for Obsidian
CJK Count
10 months ago by Louie Kurenai
Efficient Word Count
9 months ago by Blue Heron
Efficiently calculates and caches word counts for notes, with folder exclusion. Uses cache to avoid recalculating word counts for unchanged notes.
WPM Reading Time - How Long to Read This Text
22 days ago by Santi Younger
Calculate reading time estimates for selected text using your own reading speed in Words Per Minute.