FolderNoteLocation

Where a folder’s folder note lives.

The three concrete members are the shapes the folder-note ecosystem actually uses: charlie/charlie.md and charlie/index.md are both FolderNoteLocation.InsideFolder (they differ only in the NAME, which is why naming is a callback and not a fourth member), while charlie.md beside the folder is FolderNoteLocation.ParentFolder — whose whole point is that [[alpha/bravo/charlie]] links to a folder with no special syntax.

Import:

import type { FolderNoteLocation } from 'obsidian-dev-utils/obsidian/folder-note';

Signature:

export enum FolderNoteLocation

Members:

Member	Value	Description
Auto	'Auto'	Take the answer from the installed folder-notes plugin, falling back to a note named after its folder, inside it. The default, and resolved LIVE rather than copied.
InsideFolder	'InsideFolder'	alpha/bravo/charlie/<name>.md.
None	'None'	The vault has no folder notes at all, so every folder answers null. This is also how a caller opts out of folder-note behavior entirely.
ParentFolder	'ParentFolder'	alpha/bravo/<name>.md, beside the folder.

---

Links to this page:

• FolderNoteConfig
• ResolveFolderNoteConfigParams
• RenderInternalLinkFolderNoteOptions