programs.obsidian.enable
Whether to enable obsidian.
Type: boolean
Default:
false
Example:
true
Declared by:
programs.obsidian.package
The obsidian package to use.
Type: null or package
Default:
pkgs.obsidian
Declared by:
programs.obsidian.cli.enable
Whether to enable the Obsidian CLI in obsidian.json.
Type: boolean
Default:
false
Declared by:
programs.obsidian.defaultSettings.app
Settings to write to app.json.
Vault-specific settings take priority and will override these, if set.
Type: JSON value
Default:
null
Declared by:
programs.obsidian.defaultSettings.appearance
Settings to write to appearance.json.
Vault-specific settings take priority and will override these, if set.
Type: JSON value
Default:
null
Declared by:
programs.obsidian.defaultSettings.communityPlugins
Community plugins to install and activate.
Vault-specific settings take priority and will override these, if set.
Type: null or (list of ((submodule) or package convertible to it))
Default:
null
Declared by:
programs.obsidian.defaultSettings.communityPlugins.*.enable
Whether to enable the plugin.
Type: boolean
Default:
true
Declared by:
programs.obsidian.defaultSettings.communityPlugins.*.pkg
The plugin package.
Type: package
Declared by:
programs.obsidian.defaultSettings.communityPlugins.*.settings
Settings to include in the plugin’s data.json.
Type: JSON value
Default:
null
Declared by:
programs.obsidian.defaultSettings.corePlugins
Core plugins to activate.
Vault-specific settings take priority and will override these, if set.
Type: null or (list of ((submodule) or (one of “audio-recorder”, “backlink”, “bases”, “bookmarks”, “canvas”, “command-palette”, “daily-notes”, “editor-status”, “file-explorer”, “file-recovery”, “footnotes”, “global-search”, “graph”, “markdown-importer”, “note-composer”, “outgoing-link”, “outline”, “page-preview”, “properties”, “publish”, “random-note”, “slash-command”, “slides”, “switcher”, “sync”, “tag-pane”, “templates”, “webviewer”, “word-count”, “workspaces”, “zk-prefixer”) convertible to it))
Default:
null
Declared by:
programs.obsidian.defaultSettings.corePlugins.*.enable
Whether to enable the plugin.
Type: boolean
Default:
true
Declared by:
programs.obsidian.defaultSettings.corePlugins.*.name
The plugin.
Type: one of “audio-recorder”, “backlink”, “bases”, “bookmarks”, “canvas”, “command-palette”, “daily-notes”, “editor-status”, “file-explorer”, “file-recovery”, “footnotes”, “global-search”, “graph”, “markdown-importer”, “note-composer”, “outgoing-link”, “outline”, “page-preview”, “properties”, “publish”, “random-note”, “slash-command”, “slides”, “switcher”, “sync”, “tag-pane”, “templates”, “webviewer”, “word-count”, “workspaces”, “zk-prefixer”
Declared by:
programs.obsidian.defaultSettings.corePlugins.*.settings
Plugin settings to include.
Type: JSON value
Default:
null
Declared by:
programs.obsidian.defaultSettings.cssSnippets
CSS snippets to install.
Vault-specific settings take priority and will override these, if set.
Type: null or (list of ((submodule) or absolute path convertible to it))
Default:
null
Declared by:
programs.obsidian.defaultSettings.cssSnippets.*.enable
Whether to enable the snippet.
Type: boolean
Default:
true
Declared by:
programs.obsidian.defaultSettings.cssSnippets.*.name
Name of the snippet.
Type: string
Default:
lib.strings.removeSuffix ".css" (builtins.baseNameOf source)
Declared by:
programs.obsidian.defaultSettings.cssSnippets.*.source
Path of the source file.
Type: null or absolute path
Default:
null
Declared by:
programs.obsidian.defaultSettings.cssSnippets.*.text
Text of the file.
Type: null or string
Default:
null
Declared by:
programs.obsidian.defaultSettings.extraFiles
Extra files to link to the vault directory.
Vault-specific settings take priority and will override these, if set.
Type: null or (attribute set of (submodule))
Default:
null
Declared by:
programs.obsidian.defaultSettings.extraFiles.<name>.source
Path of the source file or directory.
Type: null or absolute path
Default:
null
Declared by:
programs.obsidian.defaultSettings.extraFiles.<name>.target
Path to target relative to the vault’s directory.
Type: string
Default:
name
Declared by:
programs.obsidian.defaultSettings.extraFiles.<name>.text
Text of the file.
Type: null or string
Default:
null
Declared by:
programs.obsidian.defaultSettings.hotkeys
Hotkeys to configure.
Vault-specific settings take priority and will override these, if set.
Type: null or (attribute set of list of (submodule))
Default:
null
Declared by:
programs.obsidian.defaultSettings.hotkeys.<name>.*.key
The hotkey.
Type: string
Declared by:
programs.obsidian.defaultSettings.hotkeys.<name>.*.modifiers
The hotkey modifiers.
Type: list of string
Default:
[ ]
Declared by:
programs.obsidian.defaultSettings.themes
Themes to install.
Vault-specific settings take priority and will override these, if set.
Type: null or (list of ((submodule) or package convertible to it))
Default:
null
Declared by:
programs.obsidian.defaultSettings.themes.*.enable
Whether to set the theme as active.
Type: boolean
Default:
true
Declared by:
programs.obsidian.defaultSettings.themes.*.pkg
The theme package.
Type: package
Declared by:
programs.obsidian.vaults
List of vaults to create.
Type: attribute set of (submodule)
Default:
{ }
Declared by:
programs.obsidian.vaults.<name>.enable
Whether this vault should be generated.
Type: boolean
Default:
true
Declared by:
programs.obsidian.vaults.<name>.settings.app
Settings to write to app.json.
Type: JSON value
Default:
config.programs.obsidian.defaultSettings.app
Declared by:
programs.obsidian.vaults.<name>.settings.appearance
Settings to write to appearance.json.
Type: JSON value
Default:
config.programs.obsidian.defaultSettings.appearance
Declared by:
programs.obsidian.vaults.<name>.settings.communityPlugins
Community plugins to install and activate.
Type: null or (list of ((submodule) or package convertible to it))
Default:
config.programs.obsidian.defaultSettings.communityPlugins
Declared by:
programs.obsidian.vaults.<name>.settings.communityPlugins.*.enable
Whether to enable the plugin.
Type: boolean
Default:
true
Declared by:
programs.obsidian.vaults.<name>.settings.communityPlugins.*.pkg
The plugin package.
Type: package
Declared by:
programs.obsidian.vaults.<name>.settings.communityPlugins.*.settings
Settings to include in the plugin’s data.json.
Type: JSON value
Default:
null
Declared by:
programs.obsidian.vaults.<name>.settings.corePlugins
Core plugins to activate.
Type: null or (list of ((submodule) or (one of “audio-recorder”, “backlink”, “bases”, “bookmarks”, “canvas”, “command-palette”, “daily-notes”, “editor-status”, “file-explorer”, “file-recovery”, “footnotes”, “global-search”, “graph”, “markdown-importer”, “note-composer”, “outgoing-link”, “outline”, “page-preview”, “properties”, “publish”, “random-note”, “slash-command”, “slides”, “switcher”, “sync”, “tag-pane”, “templates”, “webviewer”, “word-count”, “workspaces”, “zk-prefixer”) convertible to it))
Default:
config.programs.obsidian.defaultSettings.corePlugins
Declared by:
programs.obsidian.vaults.<name>.settings.corePlugins.*.enable
Whether to enable the plugin.
Type: boolean
Default:
true
Declared by:
programs.obsidian.vaults.<name>.settings.corePlugins.*.name
The plugin.
Type: one of “audio-recorder”, “backlink”, “bases”, “bookmarks”, “canvas”, “command-palette”, “daily-notes”, “editor-status”, “file-explorer”, “file-recovery”, “footnotes”, “global-search”, “graph”, “markdown-importer”, “note-composer”, “outgoing-link”, “outline”, “page-preview”, “properties”, “publish”, “random-note”, “slash-command”, “slides”, “switcher”, “sync”, “tag-pane”, “templates”, “webviewer”, “word-count”, “workspaces”, “zk-prefixer”
Declared by:
programs.obsidian.vaults.<name>.settings.corePlugins.*.settings
Plugin settings to include.
Type: JSON value
Default:
null
Declared by:
programs.obsidian.vaults.<name>.settings.cssSnippets
CSS snippets to install.
Type: null or (list of ((submodule) or absolute path convertible to it))
Default:
config.programs.obsidian.defaultSettings.cssSnippets
Declared by:
programs.obsidian.vaults.<name>.settings.cssSnippets.*.enable
Whether to enable the snippet.
Type: boolean
Default:
true
Declared by:
programs.obsidian.vaults.<name>.settings.cssSnippets.*.name
Name of the snippet.
Type: string
Default:
lib.strings.removeSuffix ".css" (builtins.baseNameOf source)
Declared by:
programs.obsidian.vaults.<name>.settings.cssSnippets.*.source
Path of the source file.
Type: null or absolute path
Default:
null
Declared by:
programs.obsidian.vaults.<name>.settings.cssSnippets.*.text
Text of the file.
Type: null or string
Default:
null
Declared by:
programs.obsidian.vaults.<name>.settings.extraFiles
Extra files to link to the vault directory.
Type: null or (attribute set of (submodule))
Default:
config.programs.obsidian.defaultSettings.extraFiles
Declared by:
programs.obsidian.vaults.<name>.settings.extraFiles.<name>.source
Path of the source file or directory.
Type: null or absolute path
Default:
null
Declared by:
programs.obsidian.vaults.<name>.settings.extraFiles.<name>.target
Path to target relative to the vault’s directory.
Type: string
Default:
name
Declared by:
programs.obsidian.vaults.<name>.settings.extraFiles.<name>.text
Text of the file.
Type: null or string
Default:
null
Declared by:
programs.obsidian.vaults.<name>.settings.hotkeys
Hotkeys to configure.
Type: null or (attribute set of list of (submodule))
Default:
config.programs.obsidian.defaultSettings.hotkeys
Declared by:
programs.obsidian.vaults.<name>.settings.hotkeys.<name>.*.key
The hotkey.
Type: string
Declared by:
programs.obsidian.vaults.<name>.settings.hotkeys.<name>.*.modifiers
The hotkey modifiers.
Type: list of string
Default:
[ ]
Declared by:
programs.obsidian.vaults.<name>.settings.themes
Themes to install.
Type: null or (list of ((submodule) or package convertible to it))
Default:
config.programs.obsidian.defaultSettings.themes
Declared by:
programs.obsidian.vaults.<name>.settings.themes.*.enable
Whether to set the theme as active.
Type: boolean
Default:
true
Declared by:
programs.obsidian.vaults.<name>.settings.themes.*.pkg
The theme package.
Type: package
Declared by:
programs.obsidian.vaults.<name>.target
Path to target vault relative to the user’s HOME.
Type: string
Default:
name
Declared by: