1 README: vim-asciidoc-folding |
|
2 ============================ |
|
3 :author: Matthew Todd |
|
4 :date: 2014-09-02 |
|
5 :toc: |
|
6 |
|
7 |
|
8 |
|
9 == Introduction |
|
10 |
|
11 This plugin provides a fold expression for vim to enable folding asciidoc files |
|
12 (like this one.) |
|
13 |
|
14 == Installation |
|
15 |
|
16 After installing the files, you may need to set the `foldmethod` to `foldexpr`. |
|
17 You may want to consider doing this with an autocommand or ftplugin file, so |
|
18 it's automatically done whenever you load an asciidoc file. |
|
19 |
|
20 === Pathogen et al. |
|
21 |
|
22 Just drop the files from the git repository in `~/.vim/bundle/`, as you would |
|
23 with any other pathogen plugin. Be it just unzipping the files, doing a git |
|
24 clone, or a git submodule. |
|
25 |
|
26 === Manually |
|
27 |
|
28 Drop `folding.vim` into `~/.vim/after/ftplugin/asciidoc/` |
|
29 |
|
30 == Dependencies |
|
31 |
|
32 This plugin has some dependencies on the asciidoc syntax highlighting. In |
|
33 particular, for ignoring any ='s in listing blocks. There isn't a bundled |
|
34 asciidoc syntax file nor an official one, as far as I'm aware. So you might |
|
35 have to tweak this plugin to work with other syntax highlighters. You can |
|
36 always also send me an email or issue if you find one that doesn't work, so |
|
37 that I can add support. |
|
38 |
|
39 == Limitations |
|
40 |
|
41 This plugin has the limitation that it only supports Atx style sections, not |
|
42 Setext style sections. |
|
43 |
|
44 .Supported |
|
45 ----------------------------------------------------------- |
|
46 == Level 1 |
|
47 |
|
48 === Level 2 |
|
49 ----------------------------------------------------------- |
|
50 |
|
51 .Not Supported |
|
52 ----------------------------------------------------------- |
|
53 Level 1 |
|
54 ------- |
|
55 |
|
56 Level 2 |
|
57 ~~~~~~~ |
|
58 ----------------------------------------------------------- |
|
59 |
|
60 |
|
61 See http://asciidoctor.org/docs/asciidoc-recommended-practices/ for more info. |
|
62 |
|
63 |
|
64 == Usage |
|
65 |
|
66 See the included help file (`:help asciidoc-folding`) for more information on |
|
67 how to use this plugin. |
|
68 |
|
69 |
|
70 == License |
|
71 |
|
72 This plugin was originally based on vim-markdown-plugin, found here |
|
73 https://github.com/nelstrom/vim-markdown-folding, copyright (c) Drew Neil and |
|
74 distributed under the same terms as Vim itself. As such, this derivative |
|
75 plugin is also distributed under the same terms as Vim itself. See `:help |
|
76 license` for more information. |
|
77 |
|