neorg
A Neovim plugin for structured note-taking, task management, and document writing using a single plaintext file format.
What is neorg?
Neorg is a Neovim plugin that serves as an all-encompassing tool for structured note-taking, project management, time tracking, and document writing. It solves the problem of fragmented organization tools by unifying everything under a single plaintext file format (.norg), allowing users to manage their workflow entirely within Neovim.
Neovim users seeking an integrated, text-based system for note-taking, task management, and document creation without leaving their editor.
Developers choose Neorg for its deep integration with Neovim, extensibility, and the ability to handle multiple organization needs through a consistent, learn-once file format, reducing context switching.
Overview
Modernity meets insane extensibility. The future of organizing your life in Neovim.
Use Cases
Best For
- Taking structured notes in plaintext within Neovim
- Managing personal projects and tasks directly in an editor
- Tracking time spent on coding or writing projects
- Creating slideshows and typeset documents using markup
- Building a personal knowledge base with interconnected notes
- Extending Neovim with custom organization workflows
Not Ideal For
- Teams needing real-time collaborative editing or cloud synchronization features
- Users who want a simple, GUI-based note-taking app without any Neovim configuration
- Projects that require editing in multiple editors or platforms with full feature parity
- Developers prioritizing long-term stability over cutting-edge features, due to occasional breaking changes
Pros & Cons
Pros
All features from structured notes to slideshows use the same .norg format, reducing learning overhead and ensuring deep integration between tools, as highlighted in the README.
Operates entirely within Neovim, allowing developers to manage tasks, notes, and time tracking without context switching, leveraging the editor's native capabilities.
Built for customization through Lua modules, enabling users to expand functionality or adapt workflows, which is a core part of Neorg's architecture.
.norg files are designed to be expressive and easy to parse, making them usable outside Neorg for basic editing, enhancing data portability and lock-in avoidance.
Cons
Requires luarocks and specific setup steps, with the README admitting it's 'slightly more complex than average', and dependency management can be finicky, especially on Windows.
The project is described as 'young software' with 'occasional breaking workflow changes', necessitating version pinning and careful updates, which can disrupt workflows.
Currently only supports certain plugin managers like lazy.nvim and rocks.nvim, with others not supported 'for the time being', restricting flexibility for some Neovim configurations.
Frequently Asked Questions
Related Projects
orgmodeOrgmode clone written in Lua for Neovim 0.11.0+.
obsidian.nvimObsidian 🤝 Neovim (actively maintained version)
telekasten.nvimA Neovim (lua) plugin for working with a markdown zettelkasten / wiki and mixing it with a journal, based on telescope.nvim
venn.nvimDraw ASCII diagrams in Neovim
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.