https://github.com/axvr/org.vim

Org mode syntax highlighting and folding for Vim.
https://github.com/axvr/org.vim

minimal org-mode outline-mode syntax-highlighting vim

Last synced: 28 days ago
JSON representation

Org mode syntax highlighting and folding for Vim.

• Host: GitHub
• URL: https://github.com/axvr/org.vim
• Owner: axvr
• License: other
• Archived: true
• Created: 2019-02-24T00:17:30.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-16T20:02:04.000Z (over 1 year ago)
• Last Synced: 2023-11-07T19:12:35.328Z (8 months ago)
• Topics: minimal, org-mode, outline-mode, syntax-highlighting, vim
• Language: Vim Script
• Homepage: https://git.axvr.uk/org.vim
• Size: 237 KB
• Stars: 112
• Watchers: 5
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.org

Lists

• writingvim - org.vim
• awesome-stars - axvr/org.vim - Org mode syntax highlighting and folding for Vim. (Vim Script)

README

        
#+TITLE: Org mode and Outline mode syntax highlighting for Vim

Org.vim is a minimal [[https://orgmode.org][Org mode]] and

[[https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html][Outline mode]]

plugin for [[https://www.vim.org][Vim]] providing only syntax highlighting and

folding.

This plugin aims to replicate Vim's [[https://github.com/tpope/vim-markdown/][existing Markdown]]

editing experience on Org mode (and Outline mode) files, rather than trying to

be a full featured Org mode plugin—that is what Emacs is for.  Originally

created so I could use [[https://github.com/orgzly/orgzly-android/][Orgzly]]

without worrying about Emacs lock-in.

*Note*: this project is considered /feature complete/ by the author, so the

addition of new features will be unlikely.

** Installation

Installation of Org.vim can be performed by using your preferred plugin/package

management tool(s).  If you don't have a Vim package manager I recommend using

Vim 8 packages.

Just run these 2 commands from your shell.

#+BEGIN_SRC sh

git clone https://github.com/axvr/org.vim ~/.vim/pack/plugins/start/org

vim +'helptags ~/.vim/pack/plugins/start/org/doc/' +q

#+END_SRC

Make sure the following options are set in your vimrc to enable all

functionality:

#+BEGIN_SRC vim

syntax enable

filetype plugin indent on

#+END_SRC

Once installed check out the Org.vim manual (run ~:help org.txt~ to open it) for

usage information and configuration options.

** Screenshots

Different Vim colour schemes will result in different appearances.

| [[https://github.com/romainl/Apprentice][Apprentice]] | [[https://github.com/axvr/photon.vim][Photon]] |

|--------+------------|

| [[https://raw.githubusercontent.com/axvr/org.vim/images/apprentice.png]] | [[https://raw.githubusercontent.com/axvr/org.vim/images/photon.png]] |

** Licence

Copyright © 2018–2021, Alex Vear.

Org.vim is distributed under the same terms as Vim itself.

A copy of the full licence text should have been provided with this extension

in the =LICENCE= file. The license can also be viewed on the

[[http://vimdoc.sourceforge.net/htmldoc/uganda.html#license][web]] or by invoking

~:help license~ from within Vim.