Skip to content

RenderInternalLinkFolderNoteOptions

The folder-note setup renderInternalLink resolves a folder link’s note with — everything resolveFolderNoteConfig takes except the app, which the link already carries.

Import:

import type { RenderInternalLinkFolderNoteOptions } from '@mnaoumov/obsidian-lib/markdown';

Signature:

export interface RenderInternalLinkFolderNoteOptions

Properties

PropertyTypeDescription
extensions?readonly string[]The extensions a folder note may carry. See ResolveFolderNoteConfigParams.extensions.
isHidden?booleanWhether the folder note is hidden in the file explorer. See ResolveFolderNoteConfigParams.isHidden.
location?FolderNoteLocationWhere the note sits relative to its folder. See ResolveFolderNoteConfigParams.location.
resolveName?(folder: TFolder) => stringNames the folder note of a folder. See ResolveFolderNoteConfigParams.resolveName.

Links to this page: