1
Fork 0
mirror of https://github.com/Steffo99/obsidian-file-index.git synced 2024-10-15 20:57:26 +00:00
Obsidian plugin to create a metadata file about the files present in the Vault
Find a file
2024-07-02 19:08:34 +02:00
.github/workflows Remove styles.css from the release workflow 2023-11-17 15:18:41 +01:00
.editorconfig Initial commit 2023-10-28 18:05:49 +02:00
.eslintignore Initial commit 2023-10-28 18:05:49 +02:00
.eslintrc Initial commit 2023-10-28 18:05:49 +02:00
.gitignore Initial commit 2023-10-28 18:05:49 +02:00
.npmrc Initial commit 2023-10-28 18:05:49 +02:00
esbuild.config.mjs Initial commit 2023-10-28 18:05:49 +02:00
LICENSE.md Add LICENSE and NOTICE 2023-10-28 20:04:37 +02:00
main.ts Basename include extensions for non-md files 2023-11-17 14:55:11 +01:00
manifest.json Bump version to 3.0.3 2023-11-17 15:19:00 +01:00
NOTICE.md Add LICENSE and NOTICE 2023-10-28 20:04:37 +02:00
package-lock.json Bump version to 2.0.0 2023-11-06 14:56:02 +01:00
package.json Bump version to 3.0.3 2023-11-17 15:19:00 +01:00
README.md Update README.md 2024-07-02 19:08:34 +02:00
tsconfig.json Initial commit 2023-10-28 18:05:49 +02:00
version-bump.mjs Initial commit 2023-10-28 18:05:49 +02:00
versions.json Bump version to 3.0.3 2023-11-17 15:19:00 +01:00

Obsidian File Index

Obsidian plugin to create a metadata file about the files present in the Vault

About

This Obsidian plugin creates and keeps updated a file-index.json file at the root of your Vault, containing a list of all file paths and a map of all basenames to file paths.

Useful to externally render Wikilinks with no knowledge of the file structure of the vault, for example in Glassflame.

{
	"paths": [
		"README.md",
		"Garas/moto.md",
		"Garas/auto.md"
	],
	"basenames": {
		"moto": "Garas/moto.md",
		"auto": "Garas/auto.md"
	}
}

Ignore

Files can be excluded by the index by adding a file-index-ignore.json file at the root of your Vault, containing a JSON array of regular expressions that will prevent matching files from being added to the list:

[
	"^Garas",
	".*HelloWorld.*"
]

Known issues

Warning

May have some trouble distinguishing between files with the same basename, but in different folders.