diff -r 01f49b9e842c -r 3e51ac65a978 .vim/bundle/vim-asciidoc-folding/README.asciidoc --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/.vim/bundle/vim-asciidoc-folding/README.asciidoc Thu Oct 29 12:36:22 2015 +0100 @@ -0,0 +1,77 @@ +README: vim-asciidoc-folding +============================ +:author: Matthew Todd +:date: 2014-09-02 +:toc: + + + +== Introduction + +This plugin provides a fold expression for vim to enable folding asciidoc files +(like this one.) + +== Installation + +After installing the files, you may need to set the `foldmethod` to `foldexpr`. +You may want to consider doing this with an autocommand or ftplugin file, so +it's automatically done whenever you load an asciidoc file. + +=== Pathogen et al. + +Just drop the files from the git repository in `~/.vim/bundle/`, as you would +with any other pathogen plugin. Be it just unzipping the files, doing a git +clone, or a git submodule. + +=== Manually + +Drop `folding.vim` into `~/.vim/after/ftplugin/asciidoc/` + +== Dependencies + +This plugin has some dependencies on the asciidoc syntax highlighting. In +particular, for ignoring any ='s in listing blocks. There isn't a bundled +asciidoc syntax file nor an official one, as far as I'm aware. So you might +have to tweak this plugin to work with other syntax highlighters. You can +always also send me an email or issue if you find one that doesn't work, so +that I can add support. + +== Limitations + +This plugin has the limitation that it only supports Atx style sections, not +Setext style sections. + +.Supported +----------------------------------------------------------- + == Level 1 + + === Level 2 +----------------------------------------------------------- + +.Not Supported +----------------------------------------------------------- + Level 1 + ------- + + Level 2 + ~~~~~~~ +----------------------------------------------------------- + + +See http://asciidoctor.org/docs/asciidoc-recommended-practices/ for more info. + + +== Usage + +See the included help file (`:help asciidoc-folding`) for more information on +how to use this plugin. + + +== License + +This plugin was originally based on vim-markdown-plugin, found here +https://github.com/nelstrom/vim-markdown-folding, copyright (c) Drew Neil and +distributed under the same terms as Vim itself. As such, this derivative +plugin is also distributed under the same terms as Vim itself. See `:help +license` for more information. +