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
.github/workflows | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc | ||
.gitignore | ||
.npmrc | ||
esbuild.config.mjs | ||
LICENSE.md | ||
main.ts | ||
manifest.json | ||
NOTICE.md | ||
package-lock.json | ||
package.json | ||
README.md | ||
tsconfig.json | ||
version-bump.mjs | ||
versions.json |
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.