Add the initial version of the Vim help doc

This commit is contained in:
Alex Vear
2019-02-24 15:04:37 +00:00
parent 481fde5dc4
commit d17d769966
2 changed files with 57 additions and 10 deletions

View File

@@ -1,13 +1,9 @@
# Org-mode syntax highlighting for Vim # Org-mode syntax highlighting for Vim
This is a minimal [Org-mode](https://orgmode.org/) plugin for Vim. It provides Org.vim is a minimal [Org-mode](https://orgmode.org/) plugin for
only the absolute necessities (e.g. syntax highlighting, indentation, folding, [Vim](https://www.vim.org/). It provides only the absolute necessities (e.g.
etc.). The goal of this plugin is to replicate Vim's existing syntax highlighting and folding) at a high standard.
[Markdown](https://github.com/tpope/vim-markdown/) editing experience for
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. Org-mode files.
**NOTE**: This plugin is still a work in progress.
- **TODO**: test with other colorthemes
- **TODO**: fix italics
- **TODO**: fix spell checker

51
doc/org.txt Normal file
View File

@@ -0,0 +1,51 @@
*org.txt* A minimal Org-mode package providing only the necessities.
Org.vim Manual by Alex Vear~
Welcome to the org.vim user manual. *org* *org.vim* *vim-org*
1. Introduction ............................... |org-intro|
2. Installation ............................... |org-install|
3. Basic syntax ............................... |org-syntax|
4. Configuration .............................. |org-configuration|
==============================================================================
1. INTRODUCTION *org-intro*
Org.vim is a minimal Org-mode package for Vim. It provides only the absolute
necessities (e.g. syntax highlighting and folding) at a high standard.
The main goal of this package is to replicate Vim's default Markdown editing
experience for Org-mode files.
==============================================================================
2. INSTALLATION *org-install*
WIP.
==============================================================================
3. BASIC SYNTAX *org-syntax*
WIP.
==============================================================================
4. CONFIGURATION *org-configuration*
*'g:org_use_italics'*
Value: numeric~
Default: 0~
Display italic org-mode markup (e.g. `/this is italic org-mode markup/`) using
the italic variant of your font.
Note: this option is disabled by default because some terminals and monospaced
fonts don't support the use of italics.
To enable this feature place the following line in your vimrc:
>
let g:org_use_italics = 1
<
vim:et:ts=8:sts=4:sw=4:tw=78:ft=help:norl: