Documentation

Documentation for obsidian.nvim, a Neovim plugin for working with Obsidian vaults and Markdown notes.

Start here

• Getting started — understand the plugin and set up your first vault.
• Commands — explore the :Obsidian command interface.
• Keymaps and actions — configure editor mappings and actions.
• Language server — completion, navigation, references, and code actions.

Features

• Notes and vaults: Note, Workspace, Daily-Notes, Template, Unique-Note
• Links and navigation: Link, Navigation, Bookmarks, Search, Tag
• Editor integration: Completion, Folding, Footer, Images, Open, Checkbox
• Configuration and extensions: Frontmatter, File, Cache, Autocmds, Resolvers, Extensions
• Integrations: Sync, Integrations, Scripting

Reference

• Actions · Attachment · Audio-recorder · Breaking-Changes · LSP-Progress · Recipes · Statusline
• Contribute to the documentation

For help inside Neovim, run :Obsidian help or :Obsidian helpgrep. See the project README for installation and project information.