pali112/org.vim
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rewrite README in Org mode format

Browse Source
This commit is contained in:
Alex Vear
2019-12-06 22:21:15 +00:00
parent 0a98223c0b
commit d2ecdb4ed3
2 changed files with 28 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -1,31 +0,0 @@
# Org mode and Outline mode syntax highlighting for Vim
Org.vim is a very minimal [Org mode][] and [Outline mode][] plugin for
[Vim](https://www.vim.org) providing only syntax highlighting and folding.
This plugin aims to replicate Vim's [existing Markdown](https://github.com/tpope/vim-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 would be able to quickly edit and easily read Org mode
files in Vim without any of _the bells and whistles_ of the original Emacs
implementation. It also allowed me use [Orgzly](https://github.com/orgzly/orgzly-android/)
(highly recommended) without worrying about Emacs lock-in.
**Notice**: this project is considered complete by the author. You can still
report bugs and request additional features, however it is unlikely that new
features will be added.
## Licence
Copyright (c) 2018-2019, 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
[web](http://vimdoc.sourceforge.net/htmldoc/uganda.html#license) or by invoking
`:help license` from within Vim.
[Outline mode]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html
[Org mode]: https://orgmode.org

28
README.org Normal file
View File

@@ -0,0 +1,28 @@
#+TITLE: Org mode and Outline mode syntax highlighting for Vim
Org.vim is a very 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 would be able to quickly edit and easily read Org mode
files in Vim without any of /the bells and whistles/ of the original Emacs
implementation. It also allowed me use [[https://github.com/orgzly/orgzly-android/][Orgzly]]
(highly recommended) without worrying about Emacs lock-in.
*Notice*: this project is considered complete by the author. You can still
report bugs and request additional features, however it is unlikely that new
features will be added.
** Licence
Copyright (c) 2018-2019, 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.