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

Update README and Vim doc introduction

Browse Source
This commit is contained in:
Alex Vear
2019-09-22 21:53:27 +01:00
parent 1ee078feb3
commit c5113592c2
2 changed files with 20 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@@ -1,12 +1,16 @@
# Org mode and Outline mode syntax highlighting for Vim
Org.vim is a minimal [Org mode](https://orgmode.org/) plugin for
[Vim](https://www.vim.org/). It provides only the absolute necessities (e.g.
syntax highlighting and folding) at a high standard.
Org.vim is a very minimal [Org mode][] and [Outline mode][] plugin for
[Vim](https://www.vim.org) providing only syntax highlighting and folding.
The main goal of this plugin is to replicate [Vim's default
Markdown](https://github.com/tpope/vim-markdown/) editing experience for
Org mode files.
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 all _the bells and whistles_ the Emacs version provides.
It also allowed me use [Orgzly](https://github.com/orgzly/orgzly-android/)
(highly recommended) without worrying about Emacs lock-in.
## Licence
@@ -15,7 +19,9 @@ 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][] or by
invoking `:help license` from within Vim.
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.
[web]: <http://vimdoc.sourceforge.net/htmldoc/uganda.html#license>
[Outline mode]: https://www.gnu.org/software/emacs/manual/html_node/emacs/Outline-Mode.html
[Org mode]: https://orgmode.org