outline.nvim
A Neovim sidebar plugin that visualizes and navigates code symbols in a tree hierarchy, powered by LSP and other providers.
What is outline.nvim?
outline.nvim is a Neovim plugin that displays a sidebar with a hierarchical tree of code symbols, such as functions, classes, and variables, extracted from LSP or other providers. It helps developers visualize code structure and navigate large codebases efficiently by providing a collapsible outline that updates in real-time as the cursor moves.
Neovim users, particularly developers working with large or complex codebases who need better code navigation and structure visualization. It's ideal for those using LSP-supported languages, Markdown, Norg, or other providers.
Developers choose outline.nvim for its extensive customization, multi-provider support, and smooth integration with Neovim's ecosystem. Its fork from symbols-outline.nvim brings numerous fixes and improvements, offering a more stable and feature-rich alternative with better performance and configurability.
Overview
Fancy code outline sidebar to visualize and navigate code symbols in a tree hierarchy
Use Cases
Best For
- Navigating large codebases with a visual symbol hierarchy
- Understanding code structure in LSP-supported languages like JavaScript, Python, or Go
- Working with Markdown or Norg files to see heading outlines
- Quickly jumping to symbol definitions without leaving the sidebar
- Customizing symbol icons and filtering based on filetype or kind
- Using multiple outline windows across different Neovim tabpages
Not Ideal For
- Projects requiring a floating window or popup for symbol navigation instead of a fixed sidebar
- Users who need built-in Telescope integration for fuzzy-finding symbols
- Developers relying on Neovim nightly features not supported in outline.nvim, such as dropbar.nvim's breadcrumbs
- Teams wanting a miller column view for deeper symbol hierarchy navigation without additional plugins
Pros & Cons
Pros
Supports LSP, Markdown, Norg, and external providers like treesitter and ctags, allowing it to work with a wide range of file types beyond just LSP-supported languages.
Automatically updates the outline and highlights the current symbol as the cursor moves, making navigation seamless and reducing manual effort.
Offers per-filetype symbol filtering, custom icon functions, and adjustable window settings, enabling users to tailor the interface precisely to their workflow.
As a fork of symbols-outline.nvim, it incorporates numerous fixes and enhancements, such as better performance and added features like per-tabpage outlines.
Cons
The preview window can be slow when loading large buffers because it reads the entire file for syntax highlighting, impacting responsiveness in large codebases.
Does not support multiple outline windows in the same tabpage, which can be restrictive for users who want to compare outlines from different buffers side-by-side.
For full treesitter support beyond JSX and Norg, users must install separate external plugins, adding complexity to setup and maintenance.
Frequently Asked Questions
Related Projects
nvim-lspconfigQuickstart configs for Nvim LSP
lspsaga.nvimimprove neovim lsp experience
none-ls.nvimnull-ls.nvim reloaded / Use Neovim as a language server to inject LSP diagnostics, code actions, and more via Lua.
rustaceanvim🦀 Supercharge your Rust experience in Neovim! A heavily modified fork of rust-tools.nvim
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.