-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathlinny.txt
231 lines (156 loc) · 7.78 KB
/
linny.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
*Linny.vim* A personal wiki database powered by Front matter and Markdown
>
“Everything is connected.”
- Dirk Gently by Douglas Adams
===============================================================================
Contents ~
1. Introduction |Linny-introduction|
2. Setup |Linny-setup|
2.1 Install Linny.vim
2.2 Install an indexer
2.3 Minimal configuration
2.3 Custom wikitags
3.1 Global commands |Linny-global-commands|
3.1.1 LinnyMenuOpen |LinnyMenuOpen|
3.1.2 LinnyMenuClose |LinnyMenuClose|
3.1.3 LinnyNewDoc |LinnyNewDoc|
4. Configuration |Linny-configuration|
4.1 Options |Linny-options|
4.2 Mappings |Linny-mappings|
5. Bugs
6. License
7. Contributing
8. Changelog
===============================================================================
*Linny-introduction*
1. Introduction ~
Linny.vim is a personal wiki and document database powered by Front Matter and
Markdown. Linny.vim needs a Linden Indexer as companion component to work.
===============================================================================
*Linny-setup*
2. Setup ~
-------------------------------------------------------------------------------
2.1 Install linny.vim ~
Use your favorite package manager.
Using vim-plug:
Plug 'linden-project/linny.vim'
-------------------------------------------------------------------------------
2.2 Install an indexer ~
Linny.vim needs an indexer to work properly. Currently Carl is the only
working indexer for Linny.vim >= 0.6. Read the installation guideline of Carl
at https://github.com/linden-project/carl
-------------------------------------------------------------------------------
2.3 Minimal Configuration ~
Linny.vim needs some minimal configuration to work properly. The order of the
configuration is important: 1st Global options, 2nd The Linny Init call, 3rd
Custom wikitags.
Below a minimal setup:
" 1ST GLOBAL OPTION
let g:linnycfg_path_wiki_content = $HOME . '/MyWiki/wikiContent'
let g:linnycfg_path_wiki_config = $HOME . '/MyWiki/wikiConfig'
let g:linnycfg_path_index = $HOME . '/MyWiki/wikiIndex'
" 2ND Linny needs to be initialized
call linny#Init()
-------------------------------------------------------------------------------
Configure custom wikitags ~
Custom wikitags can be defined after Linny has been initialized.
" 3RD CUSTOM WIKITAGS
function! Linny_open_issue(innertag)
execute "!firefox https://github.com/linden-project/linny.vim/issues/" . a:innertag
endfunction
function! Linny_open_issue_in_opera_browser(innertag)
execute "!opera https://github.com/linden-project/linny.vim/issues/" . a:innertag
endfunction
" WIKITAG NAME PRIMARY FUNCION SECONDARY FUNCTION (OPTIONAL)
call linny#RegisterLinnyWikitag('LINNYISSUE', 'Linny_open_issue', 'Linny_open_issue_in_opera_browser')
===============================================================================
*Linny-global-commands*
Global commands ~
-------------------------------------------------------------------------------
*LinnyMenuOpen*
LinnyMenuOpen ~
>
Opens Linny Menu. If current term is set for current tab, the term menu is
opened. If only taxonomy is set for current tab the taxonomy menu is opened.
When both are unset, the home menu is opened.
<
-------------------------------------------------------------------------------
*LinnyMenuClose*
LinnyMenuClose ~
>
Closes the Linny Menu when opened.
-------------------------------------------------------------------------------
*LinnyNewDoc*
LinnyNewDoc ~
>
Creates a new document in the wiki. If the menu in a term it will add this
taxonomy and term to the front matter of the document.
Example:
:LinnyNewDoc My new Document
This creates .../wikiContent/my_new_document.md
===============================================================================
*Linny-configuration*
Configuration ~
-------------------------------------------------------------------------------
*Linny-mappings*
Mappings ~
Linny sets some default mappings. See |linnycfg_setup_autocommands| if you can
skip these default mappings and set them yourself.
-------------------------------------------------------------------------------
map '<ENTER>' ~
>
Enter executes or opens a wiki link.
map '<CTRL> <ENTER>' ~
>
CTRL + Enter executes the secondary wiki action. In case of a regular wiki link
it opens the document in a new vim tab.
-------------------------------------------------------------------------------
*Linny-options*
Options ~
g:linnycfg_path_wiki_content ~
Default: '~/Linny/wikiContent'
Path to the directory containing all Markdown files. All files are stored in
one directory without subdirectories.
The indexer needs to be configurated with this same path.
g:linnycfg_path_wiki_config ~
Default: '~/Linny/wikiConfig'
Path to the directory containing all configuration files. This directoy need
The indexer needs to be configurated with this same path.
g:linnycfg_path_index ~
Default: '~/.linny_temp/index'
Path to the generated index. The index structure should comply with the Linden
Specification.
The indexer needs to be configurated with this same path.
g:linnycfg_path_state ~
Default value: '~/.linny_temp/state'
Location where Linny.vim stores it's state data. E.g. the state of a view. When
running multiple environments you need to separate the state paths too. This directory is only used by Linny.vim
g:linnycfg_rebuild_index_command ~
Default value: ''
When the indexer is not running as deamon this command rebuilds the index.
g:linnycfg_debug ~
Default value: 0
Enables debugging information
*linnycfg_setup_autocommands*
g:linnycfg_setup_autocommands ~
Default value: 1
By settings this to 0 you disable the setup of the autocommands if you want to
define them yourself. The autocommands are defines in `plugin/linny.vim`.
===============================================================================
*Linny-bugs*
Bugs ~
Please submit bug reports in the issue tracker at
https://github.com/linden-project/linny.vim.
===============================================================================
*Linny-license*
License ~
MIT - Copyright (c) Pim Snel
===============================================================================
*Linny-contributing*
Contributing ~
See https://github.com/linden-project/linny.vim/blob/master/CONTIBUTING.md
===============================================================================
*Linny-changelog*
Changelog ~
See https://github.com/linden-project/linny.vim/blob/master/CHANGLOG.md
vim: ft=help