Skip to content

Commit 6beea6f

Browse files
committed
make readme more pretty
1 parent c37f5e0 commit 6beea6f

File tree

1 file changed

+0
-22
lines changed

1 file changed

+0
-22
lines changed

README.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -126,91 +126,69 @@ see what they can do, and learn as you go.
126126
" params
127127
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zkindex
128128
:ZkIndex [{options}]
129-
```
130129
131-
```vim
132130
" Creates and edits a new note
133131
"
134132
" Use the `inline = true` option to insert the content of the created note at the caret position, instead of writing the note on the file system.
135133
"
136134
" params
137135
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zknew
138136
:ZkNew [{options}]
139-
```
140137
141-
```vim
142138
" Creates a new note and uses the last visual selection as the title while replacing the selection with a link to the new note
143139
"
144140
" Use the `inline = true` option to replace the selection with the content of the created note, instead of writing the note on the file system.
145141
"
146142
" params
147143
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zknew
148144
:'<,'>ZkNewFromTitleSelection [{options}]
149-
```
150145
151-
```vim
152146
" Creates a new note and uses the last visual selection as the content while replacing the selection with a link to the new note
153147
"
154148
" Use the `inline = true` option to replace the selection with the content of the created note, instead of writing the note on the file system.
155149
"
156150
" params
157151
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zknew
158152
:'<,'>ZkNewFromContentSelection [{options}]
159-
```
160153
161-
```vim
162154
" cd into the notebook root
163155
" params
164156
" (optional) additional options
165157
:ZkCd [{options}]
166-
```
167158
168-
```vim
169159
" Opens a notes picker
170160
" params
171161
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zklist
172162
:ZkNotes [{options}]
173-
```
174163
175-
```vim
176164
" Opens a notes picker for active buffers (showing notebook files only).
177165
" params
178166
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zklist
179167
:ZkBuffers [{options}]
180-
```
181168
182-
```vim
183169
" Opens a notes picker for the backlinks of the current buffer
184170
" params
185171
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zklist
186172
:ZkBacklinks [{options}]
187-
```
188173
189-
```vim
190174
" Opens a notes picker for the outbound links of the current buffer
191175
" params
192176
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zklist
193177
:ZkLinks [{options}]
194-
```
195178
196-
```vim
197179
" Inserts a link at the cursor location or around the selected text.
198180
" params
199181
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zklist
200182
" One additional option is `matchSelected` (boolean) which is only applicable to inserting a link around selected text. If `true`, the note picker will search for notes similar to the selected text. Otherwise, the note picker will load all notes to filter through.
201183
" e.g. :'<'>ZkInsertLinkAtSelection {matchSelected = true}
202184
:ZkInsertLink
203185
:'<,'>ZkInsertLinkAtSelection [{options}]
204-
```
205186
206-
```vim
207187
" Opens a notes picker, filters for notes that match the text in the last visual selection
208188
" params
209189
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zklist
210190
:'<,'>ZkMatch [{options}]
211-
```
212191
213-
```vim
214192
" Opens a notes picker, filters for notes with the selected tags
215193
" params
216194
" (optional) additional options, see https://github.com/zk-org/zk/blob/main/docs/tips/editors-integration.md#zktaglist

0 commit comments

Comments
 (0)