Skip to content

pavloDeshko/obsidian-index-checker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Jun 29, 2023
5b8a1d0 ยท Jun 29, 2023

History

15 Commits
Jun 29, 2023
Jun 7, 2023
Mar 21, 2023
Jun 7, 2023
Jun 20, 2023
Mar 21, 2023
Jun 7, 2023
Jun 29, 2023
Jun 20, 2023
May 7, 2023
Jun 29, 2023
Jun 29, 2023
Jun 29, 2023
Jun 7, 2023
Jun 7, 2023
Jun 13, 2023
Mar 21, 2023
Jun 29, 2023

Repository files navigation

Obsidian Index Checker Plugin

Make sure your index (MOC) files contain all links they should contain!

Simple and unopinionated obsidian plugin which will check if all the necessary links are included in your index (MOC) files, while allowing you to maintain complete control over their structure and formatting.


Why?

Although there're a few community plugins for maintaining indexes, most of them enforce rigid structure (user defined in best cases) for all index files. What I was looking for is a more flexible solution that will simply check if all links are in place (and no files are "lost"), while allowing users to organize each of their index files in whatever way they prefer (and change it whenever they want!). Additionally, it should facilitate the addition of missing links to index files. Here's my solution to the problem, check it out :)


How it works

๐Ÿ› ๏ธ - user defines how plugin should find index(MOC) files based on their names. Example patterns could be "index", "MOC", "[FOLDER]", "_[FOLDER]" etc, where [FOLDER] stands for containing folder's name

๐Ÿ› ๏ธ - and user specifies which files should be referenced in given indexes. Currently there're three options: a) all files in the same folder b) all files in the folder and all files in subfolders c) all files in the folder and files in subfolders but only if those subfolders don't have their own indexes

โœ”๏ธ - plugin checks if all index(MOC) files contain all links they should contain. Check-up could be triggered manually or performed every time a vault is opened

๐Ÿ“ - plugin adds missing links either to the end (or start) of an index file, or to a dedicated file in the same folder, so they could be moved to their proper places in an index file. User can specify format for text of those links, like "*** [LINKS] ***" or "#ADDED_LINKS [LINKS]", where "[LINKS]" is a plug for added links, one on each line for easy copy-pasting

๐Ÿ–๏ธ - and plugin marks files that had missing links in file explorer. Those marks persist until file is modified (for index files) or cleared of any links (for dedicated "missing links" file)

Check out plugin settings page after you install it for details on all options


Make it better

You're most welcome to add PR for a new feature, bug fix or simply better solution.

OR make a feature request on thread at Obsidian community forum that I will create as soon as plugin is approved. Yes, I'm willing to expand functionality based on popular requests asap :)


Licence

MIT