Skip to content

Latest commit

 

History

History
99 lines (66 loc) · 2.74 KB

README.md

File metadata and controls

99 lines (66 loc) · 2.74 KB

Obsidian Vault Statistics Plugin

Status bar item with vault statistics including the number of notes, files, attachments, and links.

Usage

After the plugin is installed and enabled you will see a new item appear in the status bar showing you the number of notes in your vault.

  • Click on the status bar item to cycle through the available statistics.
  • Hover over the status bar item to see all of the available statistics.

Advanced Usage

Showing All Statistics

All statistics can be shown by creating and enabling a CSS snippet with the following content.

/* Show all vault statistics. */
.obsidian-vault-statistics--item {
    display: initial !important;
}

Showing Selected Statistics

Similarly to the above, one can show certain statistics using a similar method to the above. Below is a snippet that hides all by the notes and attachments statistics. The snippet can be modified to include more or different statistics.

/* Hide all statistics. */
.obsidian-vault-statistics--item {
    display: none !important;
}

/* Always show the notes and attachments statistics. */
.obsidian-vault-statistics--item-notes,
.obsidian-vault-statistics--item-attachments {
    display: initial !important;
}

Version History

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

  • Added
  • Changed
  • Deprecated
  • Removed
  • Fixed
    • Comment sections are explicitly processed and do not count toward statistics (#22)

[0.1.3] - 2022-10-25

  • Fixed
    • Fixed issue with deleted and renamed files not correctly updating file statistics (#17)
    • Removed errant debugger statement (#14)

[0.1.2] - 2022-08-05

  • Added
    • Added Settings pane
  • Changed
    • Users can now optionally show all or a subset of metrics instead of the default click-to-cycle behaviour (#6)

[0.1.1] - 2022-08-05

  • Fixed
    • Fixed issue when processing files with admonitions (#12)

[0.1.0] - 2021-12-30

  • Added
    • Added word count metric (#8)

[0.0.8] - 2021-12-18

  • Added
    • Initial support for displaying multiple statistics at the same time. (#6)

[0.0.6] - 2021-12-14

  • Fixed
    • FIXED: Reported values only contain 2 significant digits (#7)

[0.0.5] - 2021-12-12

  • Changed
    • Displayed statistics are formatted with grouping for increase readability.
    • Added Vault Size statistic which calculates the total size of all files in the vault that are understood by Obsidian The display value is scaled to the appropriate unit. (#5)

[0.0.4] - 2021-02-25

  • Fixed
    • Statistics will be calculated automatically as soon as the plugin loads.