Class Notebook

config

fs

hasLoadedNotes

markdownYoRenderer

md

notebookPath

notes

referenceMap

buildMarkdownYoOptions

• buildMarkdownYoOptions(isForPreview: boolean): RenderOptions

  Build markdown_yo render options from the current notebook config.

  Parameters

  • isForPreview: boolean

  Returns RenderOptions

clearAllNoteMarkdownEngineCaches

• clearAllNoteMarkdownEngineCaches(): void

  Returns void

deleteNote

• deleteNote(filePath: string, alreadyDeleted?: boolean): Promise<void>

  Parameters

  • filePath: string
  • alreadyDeleted: boolean = false

  Returns Promise<void>

getBacklinkedNotes

• getBacklinkedNotes(filePath: string): Promise<Notes>

  Parameters

  • filePath: string

  Returns Promise<Notes>

getNote

• getNote(filePath: string, refreshNoteRelations?: boolean): Promise<Note | null>

  Parameters

  • filePath: string
  • refreshNoteRelations: boolean = false

  Returns Promise<Note | null>

getNoteBacklinks

• getNoteBacklinks(filePath: string): Promise<Backlink[]>

  Parameters

  • filePath: string

  Returns Promise<Backlink[]>

getNoteMarkdownEngine

• getNoteMarkdownEngine(filePath: string): MarkdownEngine

  Parameters

  • filePath: string

  Returns MarkdownEngine

getNoteMarkdownEngines

• getNoteMarkdownEngines(): { [key: string]: MarkdownEngine }

  Returns { [key: string]: MarkdownEngine }

getReferences

• getReferences(
      noteFilePath: string,
      backlinkedNoteFilePath: string,
  ): Promise<Reference[]>

  Parameters

  • noteFilePath: string
  • backlinkedNoteFilePath: string

  Returns Promise<Reference[]>

initFs

• initFs(_fs?: FileSystemApi): void

  Parameters

  • Optional_fs: FileSystemApi

  Returns void

initMarkdownIt

• initMarkdownIt(options?: ExtendedMarkdownItOptions): MarkdownIt

  Parameters

  • Optionaloptions: ExtendedMarkdownItOptions

  Returns MarkdownIt

processNoteMentionsAndMentionedBy

• processNoteMentionsAndMentionedBy(filePath: string): Promise<void>

  Parameters

  • filePath: string

  Returns Promise<void>

processWikilink

• processWikilink(content: string): { link: string; text: string }

  Process wiki link

  Parameters

  • content: string

    content is string like "Test", "test.md | Test"

  Returns { link: string; text: string }

refreshNotes

• refreshNotes(args: RefreshNotesArgs): Promise<Notes>

  Parameters

  • args: RefreshNotesArgs

  Returns Promise<Notes>

refreshNotesIfNotLoaded

• refreshNotesIfNotLoaded(
      __namedParameters: RefreshNotesIfNotLoaded,
  ): Promise<Notes>

  Parameters

  • __namedParameters: RefreshNotesIfNotLoaded

  Returns Promise<Notes>

removeNoteRelations

• removeNoteRelations(filePath: string): Promise<void>

  Parameters

  • filePath: string

  Returns Promise<void>

renderMarkdown

• renderMarkdown(markdown: string, options?: { isForPreview?: boolean }): string

  Render markdown to HTML using markdown_yo (WASM) if available, otherwise falls back to markdown-it.

  Parameters

  • markdown: string
  • Optionaloptions: { isForPreview?: boolean }

  Returns string

resolveNoteAbsolutePath

• resolveNoteAbsolutePath(filePath: string): string

  Get the absolute path of the note

  Parameters

  • filePath: string

  Returns string

resolveNoteRelativePath

• resolveNoteRelativePath(filePath: string): string

  Get the relative path of the note to the notebook directory

  Parameters

  • filePath: string

  Returns string

updateConfig

• updateConfig(config: Partial<NotebookConfig>): void

  Parameters

  • config: Partial<NotebookConfig>

  Returns void

Staticinit

• init(args: NotebookConstructorArgs): Promise<Notebook>

  Parameters

  • args: NotebookConstructorArgs

  Returns Promise<Notebook>