steffo/obsidian-file-index
steffo/obsidian-file-index
1
Fork 0
mirror of https://github.com/Steffo99/obsidian-file-index.git synced 2024-11-23 13:34:23 +00:00
Code Activity
Obsidian plugin to create a metadata file about the files present in the Vault
13 commits 1 branch 5 tags 89 KiB
TypeScript 73.3%
JavaScript 26.7%
Find a file
Stefano Pigozzi 22ba88a086
Bump version to 2.0.0
2023-11-06 14:56:02 +01:00
.github/workflows Release on any tag instead of v-prefixed ones 2023-10-28 20:21:31 +02: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 Warn if multiple files have the same basename 2023-11-06 14:49:28 +01:00
manifest.json Bump version to 1.1.0 2023-10-29 02:56:54 +02: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 2.0.0 2023-11-06 14:56:02 +01:00
README.md Add ignore file feature 2023-10-29 02:55:41 +02:00
styles.css Initial commit 2023-10-28 18:05:49 +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 2.0.0 2023-11-06 14:56:02 +01:00

README.md

Obsidian File Index

About

This Obsidian plugin creates and keeps updated a steffo-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 Obsiview.

{
	"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 steffo-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.