Skip to content

Commit 8334058

Browse files
gunsguns
committed
Add vim documentation.
1 parent 7af24a3 commit 8334058

File tree

2 files changed

+140
-8
lines changed

2 files changed

+140
-8
lines changed

‎README.markdown‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@
1818
`Y8bod8P'o888o`Y8bod8P' 888 `V88V"V8P'd888b `Y8bod8P'
1919
888
2020
.o. 88P
21-
. `Y888P . o8o
22-
.o8 .o8 `"'
23-
.oooo.o.o888oo .oooo. .o888oooooo .ooooo.
24-
d88( "8 888 `P )88b 888 `888 d88' `"Y8
25-
`"Y88b. 888 .oP"888 888 888 888
26-
o. )88b 888 .d8( 888 888 . 888 888 .o8
27-
8""888P' "888"`Y888""8o "888"o888o`Y8bod8P'
21+
. `Y888P . o8o
22+
.o8 .o8 '"'
23+
.oooo.o.o888oo .oooo. .o888oooooo .ooooo.
24+
d88( "8 888 `P )88b 888 `888 d88' `"Y8
25+
`"Y88b. 888 .oP"888 888 888 888
26+
o. )88b 888 .d8( 888 888 . 888 888 .o8
27+
8""888P' "888"`Y888""8o "888"o888o`Y8bod8P'
2828

2929

3030

@@ -115,7 +115,7 @@ let g:clojure_fuzzy_indent_patterns = "with.*,def.*,let.*"
115115
When indenting multiline strings, align subsequent lines to the column
116116
after the opening quote, instead of the same column.
117117

118-
Demo:
118+
For example:
119119

120120
```clojure
121121
(def default

‎doc/clojure.txt‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
*clojure* *clojure.txt* *clojure.vim* *vim-clojure-static*
2+
>
3+
o8o
4+
'"'
5+
oooo ooooooo ooo. .oo. .oo.
6+
`88. .8' `888 `888P"Y88bP"Y88b
7+
`88..8' 888 888 888 888
8+
`888' 888 888 888 888
9+
`8' o888oo888o o888o o888o
10+
11+
12+
oooo o8o
13+
`888 '"'
14+
.ooooo. 888 .ooooo. oooooooo oooo oooo d8b .ooooo.
15+
d88' `"Y8 888 d88' `88b`888`888 `888 `888""8Pd88' `88b
16+
888 888 888 888 888 888 888 888 888ooo888
17+
888 .o8 888 888 888 888 888 888 888 888 .o
18+
`Y8bod8P'o888o`Y8bod8P' 888 `V88V"V8P'd888b `Y8bod8P'
19+
888
20+
.o. 88P
21+
. `Y888P . o8o
22+
.o8 .o8 '"'
23+
.oooo.o.o888oo .oooo. .o888oooooo .ooooo.
24+
d88( "8 888 `P )88b 888 `888 d88' `"Y8
25+
`"Y88b. 888 .oP"888 888 888 888
26+
o. )88b 888 .d8( 888 888 . 888 888 .o8
27+
8""888P' "888"`Y888""8o "888"o888o`Y8bod8P'
28+
<
29+
30+
========================================================================
31+
INTRODUCTION *clojure-introduction*
32+
33+
Meikel Brandmeyer's excellent Clojure runtime files, extracted and
34+
decomplected for static editing and for use with alternate Clojure
35+
development plugins.
36+
37+
========================================================================
38+
OPTIONS *clojure-options* *clojure-indent*
39+
40+
The indent script has a few configurable options. Documentation with
41+
default values below:
42+
43+
*g:clojure_maxlines*
44+
45+
Maximum scan distance of searchpairpos().
46+
>
47+
" Default
48+
let g:clojure_maxlines = 100
49+
<
50+
51+
*g:clojure_fuzzy_indent* *g:clojure_fuzzy_indent_patterns*
52+
53+
Indent words that match patterns as if they are included in 'lispwords'
54+
>
55+
" Default
56+
let g:clojure_fuzzy_indent = 1
57+
let g:clojure_fuzzy_indent_patterns = "with.*,def.*,let.*"
58+
<
59+
60+
*g:clojure_align_multiline_strings*
61+
62+
When indenting multiline strings, align subsequent lines to the column
63+
after the opening quote, instead of the same column.
64+
65+
For example:
66+
>
67+
(def default
68+
"Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
69+
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
70+
enim ad minim veniam, quis nostrud exercitation ullamco laboris
71+
nisi ut aliquip ex ea commodo consequat.")
72+
73+
(def aligned
74+
"Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do
75+
eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut
76+
enim ad minim veniam, quis nostrud exercitation ullamco laboris
77+
nisi ut aliquip ex ea commodo consequat.")
78+
<
79+
80+
>
81+
" Default
82+
let g:clojure_align_multiline_strings = 0
83+
<
84+
85+
=======================================================================
86+
ABOUT *clojure-about*
87+
88+
This document and associated runtime files are maintained at:
89+
https://github.com/guns/vim-clojure-static
90+
91+
*syntax/clojure.vim*
92+
93+
Authors: Toralf Wittner <toralf.wittner@gmail.com>
94+
modified by Meikel Brandmeyer <mb@kotka.de>
95+
URL: http://kotka.de/projects/clojure/vimclojure.html
96+
97+
Maintainer: Sung Pae <self@sungpae.com>
98+
URL: https://github.com/guns/vim-clojure-static
99+
100+
*indent/clojure.vim*
101+
*ftplugin/clojure.vim*
102+
103+
Author: Meikel Brandmeyer <mb@kotka.de>
104+
URL: http://kotka.de/projects/clojure/vimclojure.html
105+
106+
Maintainer: guns <self@sungpae.com>
107+
URL: https://github.com/guns/vim-clojure-static
108+
109+
VimClojure license:
110+
111+
Copyright 2008-2012 (c) Meikel Brandmeyer.
112+
All rights reserved.
113+
114+
Permission is hereby granted, free of charge, to any person obtaining a copy
115+
of this software and associated documentation files (the "Software"), to deal
116+
in the Software without restriction, including without limitation the rights
117+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
118+
copies of the Software, and to permit persons to whom the Software is
119+
furnished to do so, subject to the following conditions:
120+
121+
The above copyright notice and this permission notice shall be included in
122+
all copies or substantial portions of the Software.
123+
124+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
125+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
126+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
127+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
128+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
129+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
130+
THE SOFTWARE.
131+
132+
vim:ft=help tw=72 norl:

0 commit comments

Comments
 (0)