Top Related Projects
Quick Overview
vim-orgmode is a Vim plugin that aims to implement Org mode functionality in Vim. It provides features for organizing notes, managing tasks, and creating structured documents, similar to Emacs' Org mode but within the Vim environment.
Pros
- Brings powerful Org mode features to Vim users
- Supports task management, TODO lists, and agenda views
- Allows for hierarchical document structuring with folding
- Integrates well with Vim's ecosystem and keybindings
Cons
- Not as feature-complete as Emacs' Org mode
- Learning curve for users unfamiliar with Org mode concepts
- May have performance issues with very large Org files
- Limited export options compared to Emacs' Org mode
Getting Started
To install vim-orgmode using a plugin manager like vim-plug, add the following to your .vimrc
:
Plug 'jceb/vim-orgmode'
Then run :PlugInstall
in Vim.
Basic usage:
- Create a new Org file:
vim myorg.org
- Start a heading with an asterisk:
* My First Heading
- Create a TODO item:
** TODO Learn vim-orgmode
- Toggle TODO state: Move cursor to the TODO line and press
<localleader>ct
- Create a timestamp:
<localleader>sa
- Open agenda view:
<localleader>caa
Refer to the plugin's documentation for more advanced features and keybindings.
Competitor Comparisons
Personal Wiki for Vim
Pros of vimwiki
- Simpler setup and easier to get started with
- Built-in diary functionality
- More flexible markup syntax, not limited to org-mode format
Cons of vimwiki
- Less powerful task management and scheduling features
- Limited export options compared to org-mode's extensive export capabilities
- Lacks advanced features like agenda views and clock tracking
Code Comparison
vimwiki:
let g:vimwiki_list = [{'path': '~/vimwiki/',
\ 'syntax': 'markdown', 'ext': '.md'}]
vim-orgmode:
let g:org_agenda_files = ['~/org/work.org', '~/org/home.org']
let g:org_todo_keywords = ['TODO', 'NEXT', '|', 'DONE']
Both plugins offer ways to customize their behavior, but vim-orgmode typically requires more configuration to fully utilize its features. vimwiki's setup is often simpler, focusing on quick note-taking and basic wiki functionality. vim-orgmode, being an Emacs org-mode port, offers more advanced organizational features but may have a steeper learning curve for those unfamiliar with org-mode concepts.
Modernity meets insane extensibility. The future of organizing your life in Neovim.
Pros of Neorg
- Written in Lua, providing better performance and integration with Neovim
- More extensive feature set, including advanced task management and project planning
- Actively maintained with frequent updates and a growing community
Cons of Neorg
- Requires Neovim, limiting compatibility with traditional Vim setups
- Steeper learning curve due to its more complex structure and Lua-based configuration
Code Comparison
vim-orgmode:
* TODO Learn Org mode
DEADLINE: <2023-05-15 Mon>
:PROPERTIES:
:CREATED: [2023-05-01 Mon 09:00]
:END:
Neorg:
* TODO Learn Neorg
- (2023-05-15) Deadline
@created(2023-05-01 09:00)
Both examples demonstrate basic task creation with deadlines and metadata, but Neorg's syntax is slightly more concise and uses different conventions for specifying dates and properties.
Orgmode clone written in Lua for Neovim 0.10.0+.
Pros of orgmode
- Written in Lua, providing better performance and integration with Neovim
- More actively maintained with frequent updates and bug fixes
- Supports Treesitter for improved syntax highlighting and parsing
Cons of orgmode
- Limited compatibility with Vim, as it's designed specifically for Neovim
- May lack some features present in vim-orgmode due to its newer development
Code Comparison
vim-orgmode:
" Enable vim-orgmode
Plug 'jceb/vim-orgmode'
" Basic configuration
let g:org_agenda_files = ['~/org/index.org']
let g:org_todo_keywords = ['TODO', 'NEXT', '|', 'DONE']
orgmode:
-- Enable orgmode
use {'nvim-orgmode/orgmode', config = function()
require('orgmode').setup{}
end}
-- Basic configuration
require('orgmode').setup({
org_agenda_files = {'~/org/*'},
org_default_notes_file = '~/org/refile.org',
})
Both plugins offer similar functionality for working with Org files in Vim/Neovim, but orgmode is more tailored for Neovim users and leverages modern features like Lua integration and Treesitter support.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
-
Vim-OrgMode
#+ATTR_HTML: title="Join the chat at https://gitter.im/jceb/vim-orgmode" [[https://gitter.im/jceb/vim-orgmode?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge][file:https://badges.gitter.im/jceb/vim-orgmode.svg]] [[https://travis-ci.org/jceb/vim-orgmode][file:https://travis-ci.org/jceb/vim-orgmode.svg]] [[https://codecov.io/gh/jceb/vim-orgmode][file:https://codecov.io/gh/jceb/vim-orgmode/branch/master/graph/badge.svg]]
Text outlining and task management for Vim based on [[http://orgmode.org/][Emacs' Org-Mode]].
The idea for this plugin was born by listening to the [[http://twit.tv/floss136][Floss Weekly podcast]] introducing Emacs Org-Mode. Org-Mode has a lot of strong features like folding, views (sparse tree) and scheduling of tasks. These are completed by hyperlinks, tags, todo states, priorities aso.
vim-orgmode aims at providing the same functionality for Vim.
[[https://github.com/jceb/vim-orgmode/blob/master/examples/mylife.org][file:examples/mylife.gif]]
** Features Currently vim-orgmode does not support all orgmode features but is quite usable. Short list of the already supported features:
- Syntax highlighting
- Cycle visibility of headings (folding)
- Navigate between headings
- Edit the structure of the document: add, move, promote, denote headings and more
- Hyperlinks within vim-orgmode and outside (files, webpages, etc.)
- TODO list management
- Tags for headings
- Lists in alphanumeric and bullet item notation and checkbox support
- Basic date handling
- Export to other formats (via Emacs' Org-Mode)
-
Installation and Usage Installation and usage instructions are found in the file [[doc/orgguide.txt][doc/orgguide.txt]].
-
License Information about the license is found in file [[LICENSE]].
-
Changelog All changes are found in file [[https://github.com/jceb/vim-orgmode/blob/master/CHANGELOG.org][CHANGELOG.org]]
Top Related Projects
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot