Skip to content

Commit a3e25e3

Browse files
glupi-bornaJoeKar
andauthored
docs: Improve plugin documentation (zyedidia#3240)
* docs: Improve documentation `commands.md` - documented the `reopen` command - improved the documentation of the `reload` command `plugins.md` - added direct links to relevant external documentation pages - rewrote some sections - documented missing functions/callbacks - added a note about installing/managing plugins * Omit number of default plugins Co-authored-by: Jöran Karl <[email protected]> --------- Co-authored-by: Jöran Karl <[email protected]>
1 parent f0f4afa commit a3e25e3

File tree

2 files changed

+141
-79
lines changed

2 files changed

+141
-79
lines changed

runtime/help/commands.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,14 +107,19 @@ quotes here but these are not necessary when entering the command in micro.
107107

108108
* `plugin available`: show available plugins that can be installed.
109109

110-
* `reload`: reloads all runtime files.
110+
* `reload`: reloads all runtime files (settings, keybindings, syntax files,
111+
colorschemes, plugins). All plugins will be unloaded by running their
112+
`deinit()` function (if it exists), and then loaded again by calling the
113+
`preinit()`, `init()` and `postinit()` functions (if they exist).
111114

112115
* `cd 'path'`: Change the working directory to the given `path`.
113116

114117
* `pwd`: Print the current working directory.
115118

116119
* `open 'filename'`: Open a file in the current buffer.
117120

121+
* `reopen`: Reopens the current file from disk.
122+
118123
* `reset 'option'`: resets the given option to its default value
119124

120125
* `retab`: Replaces all leading tabs with spaces or leading spaces with tabs

0 commit comments

Comments
 (0)