https://github.com/Canna71/obsidian-janitor
Performs various maintenance tasks on the Obsidian vault
https://github.com/Canna71/obsidian-janitor
Last synced: 4 months ago
JSON representation
Performs various maintenance tasks on the Obsidian vault
- Host: GitHub
- URL: https://github.com/Canna71/obsidian-janitor
- Owner: Canna71
- License: other
- Fork: true (obsidianmd/obsidian-sample-plugin)
- Created: 2022-08-13T18:36:59.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-12T10:44:24.000Z (about 1 year ago)
- Last Synced: 2024-08-13T07:17:53.408Z (8 months ago)
- Language: TypeScript
- Size: 340 KB
- Stars: 96
- Watchers: 3
- Forks: 5
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - Canna71/obsidian-janitor - Performs various maintenance tasks on the Obsidian vault (TypeScript)
README
# Janitor Plugin
This plugin helps keeping the vault under control, by possibily removing the following resources.
## Orphan files
These are media or attachments that are not referenced anywhere. Janitor looks also in frontmatters (for example for `annotation-target` or similar)
## Empty files
These are files either empty or consisting only of whitespace (newlines, tabs, and so on)
## Big Files
You can specify a limit size and Janitor will prompt you delete big files. Use it at your own risk. By default Janitor will prompt if about to delete a big file, even if the "ask confirmation" setting is disable.
## Expired Notes
Janitor uses an approach similar to [Obsidian Expiring Notes](https://github.com/joerncodes/obsidian-expiring-notes) in which a (configurable) attribute is looked for in the frontmatter in order to set an expiration date to notes. For Example:
```
---
expires: 2022-09-01
---
```
Janitor also comes with utilities command used to easily set expiration date into notes.
## Excluded Files
Janitor can exclude files that are excluded by Obsidian (Settings->Files & Linkds->Excluded files) but users can also specify different criterias for exclusions (for example based on file extension or path).
## How to run
Janitor could be set to run at startup. If "ask confirmation" is set, it will prompt the user with a confirmation dialog. User can select which files to delete and which action to perform (trash in Obsidian, trash in OS or delete permanently).
Janitor scan can also be launched from a ribbon button or from commands.
