├── .gitignore
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | doc/tags
2 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # vim-pandoc-legacy
 2 | 
 3 | Provided support for pandoc in vim. 
 4 | 
 5 | The original vim-pandoc (available here) has been replaced by vim-pantondoc
 6 | (now, vim-pandoc). All the users of the old vim-pandoc are suggested to move
 7 | over the combo of the new [vim-pandoc][], [vim-pandoc-syntax][], and
 8 | [vim-pandoc-after][]. vim-pandoc provides the writing environment setup,
 9 | vim-pandoc-syntax provides the syntax file (and tests), and vim-pandoc-after
10 | support for third-party plugins (like ultisnips, unite, nrrwrgn, etc.).
11 | 
12 | [vim-pandoc]: https://github.com/vim-pandoc/vim-pandoc
13 | [vim-pandoc-syntax]: https://github.com/vim-pandoc/vim-pandoc-syntax
14 | [vim-pandoc-after]: https://github.com/vim-pandoc/vim-pandoc-after
15 | 
16 | ## Moving over to the new vim-pandoc
17 | 
18 | ### What's different
19 | 
20 | * The new vim-pandoc is modular, and extremely configurable. You decide what to
21 |   use from it, and how.
22 | * The syntax file is no longer included in the bundle. The user must install
23 |   `vim-pandoc-syntax`. 
24 |   The syntax file has received many improvements; it is now faster and more
25 |   complete.
26 | * Integration with third-party plugins is no longer included in the bundle. The
27 |   user must install `vim-pandoc-after`.
28 |   More third-party plugins are supported, and old ones have been updated.
29 | * The executors system has been replaced by a single `:Pandoc` command. 
30 |   pandoc can be executed asynchronously (if possible).
31 | * New features: TOC functionality, keyboard navigation and operators, improved
32 |   and smarted folding, etc.
33 | 
34 | ### Migration instructions
35 | 
36 | First, uninstall vim-pandoc. If you have installed it by cloning the repo and
37 | using pathogen, Vundle or Neobundle, it should be enough to delete the
38 | `.vim/bundle/vim-pandoc` directory. If you have used Vundle or NeoBundle, you
39 | should also delete the configuration for it in your `.vimrc`.
40 | 
41 | You should now install the new [vim-pandoc][] and [vim-pandoc-syntax][] plugins
42 | (and if third party plugin integration is needed, [vim-pandoc-after][]).
43 | 
44 | Using Vundle, simply add
45 | 
46 |     Plugin 'vim-pandoc/vim-pandoc'
47 |     Plugin 'vim-pandoc/vim-pandoc-syntax'
48 |     Plugin 'vim-pandoc/vim-pandoc-after'
49 | 
50 | to your `.vimrc`, source it (`:so %`), and execute `:PluginInstall`. NeoBundle
51 | users should be able to do something similar.
52 | 
53 | ### Configuration variables
54 | 
55 | Configuration variables have been renamed. This is a rough guide of these
56 | changes. 
57 | 
58 | * `g:pandoc_use_hard_wraps`/`g:pandoc_use_soft_wraps` =>
59 |    `g:pandoc#formatting#mode` = "h"/"s"
60 | * `g:pandoc_auto_format` => `g:pandoc#formatting#mode` += "a"
61 | * `g:pandoc_no_folding` => `g:pandoc#modules#disabled` = ["folding"]
62 | * `g:pandoc_no_empty_implicits` => not available
63 | * `g:pandoc_no_spans` => not available
64 | * `g:pandoc_bibfiles` => `g:pandoc#biblio#bibs`
65 | * `g:pandoc_use_bibtool` => `g:pandoc#biblio#use_bibtool`
66 | 
67 | Note the new vim-pandoc is much more configurable, and has a modular design.
68 | Please consult vim-pandoc's help file (`:he vim-pandoc`) for more information.
69 | (also `:he vim-pandoc-syntax`).
70 | 
71 | ## Keep using the old vim-pandoc (not recommended)
72 | 
73 | If, for some reason, you want to keep using the old vim-pandoc version, you
74 | should clone this repo and revert to commit
75 | c905b50dce4f58cf76235c7d47c15eb699da0b2d. Please note this version of
76 | vim-pandoc will be unsupported, and you'll be on your own.
77 | 


--------------------------------------------------------------------------------