Skip to content

obsidian-settings

This module provides utility functions for working with Obsidian settings.

Function Description
getNewLinkFormat Retrieves whether to use relative links based on the Obsidian settings.
isSpellcheckEnabled Retrieves whether the spellcheck is enabled based on the Obsidian settings.
isSpellcheckEnabledForMode Resolves a SpellcheckMode against the Obsidian settings.
shouldUseWikilinks Retrieves whether to use wikilinks based on the Obsidian settings.
Type Description
NewLinkFormat A format of the new link.
Enum Description
SpellcheckMode A way an input decides whether it is spell-checked. The spellcheck attribute is the whole mechanism: Obsidian never calls Electron’s setSpellCheckerEnabled, it only sets the attribute per element. So AlwaysOn really does spell-check with Editor > Spellcheck off, and what it invokes is Chromium’s built-in checker.