mirror of
https://github.com/Steffo99/obsidian-file-index.git
synced 2024-11-22 13:04:23 +00:00
41 lines
995 B
Markdown
41 lines
995 B
Markdown
# 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].
|
|
|
|
```json
|
|
{
|
|
"paths": [
|
|
"README.md",
|
|
"Garas/moto.md",
|
|
"Garas/auto.md"
|
|
],
|
|
"basenames": {
|
|
"moto": "Garas/moto.md",
|
|
"auto": "Garas/auto.md"
|
|
}
|
|
}
|
|
```
|
|
|
|
[Obsidian]: https://obsidian.md/
|
|
[Obsiview]: https://github.com/Steffo99/obsiview
|
|
|
|
## 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:
|
|
|
|
```json
|
|
[
|
|
"^Garas",
|
|
".*HelloWorld.*"
|
|
]
|
|
```
|
|
|
|
## Known issues
|
|
|
|
> [#WARNING]
|
|
>
|
|
> May have some trouble distinguishing between files with the same basename, but in different folders.
|