annotate doc/core.txt @ 1:7c5bd18befd2 default tip

Some basic usage
author Luka Sitas <lsitas@avatarasoftware.com>
date Tue, 10 Mar 2026 21:31:17 -0400
parents 7bb5f650cfb7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
1 *core.txt* Simple example Vim plugin
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
2
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
3 INTRODUCTION *core*
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
4
1
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
5 core is a minimal plugin providing some consistent and
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
6 re-usable functionality.
0
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
7
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
8 USAGE *core-usage*
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
9
1
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
10 function core#PopupCommand({command})
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
11 Create a popup that runs a terminal {command}
0
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
12
1
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
13 function core#ReadOnlyPopup(content)
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
14 Create a read only popup with the {contents}.
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
15 There is currently no easy way to close this buffer.
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
16
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
17 function core#ExecuteCommand(command)
7c5bd18befd2 Some basic usage
Luka Sitas <lsitas@avatarasoftware.com>
parents: 0
diff changeset
18 Executes {command} and returns the results.
0
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
19
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
20 INSTALLATION *core-install*
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
21
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
22 Using vim-plug add the following:
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
23
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
24 Plug '/home/lsitas/repos/vim_plugins/core'
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
25
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
26
7bb5f650cfb7 Initial Commit
Luka Sitas <lsitas@avatarasoftware.com>
parents:
diff changeset
27 *core* Main help entry for this plugin.