github/zyedidia.micro
2
0
Fork 0
mirror of https://github.com/zyedidia/micro.git synced 2026-03-30 06:37:14 +09:00
Code Issues Packages Projects Releases Wiki Activity

Allow plugins to add their own runtime files

Browse Source
This commit is contained in:
Zachary Yedidia
2016-09-16 11:02:10 -04:00
parent f7295a25d8
commit 149fea8b76
5 changed files with 23 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
runtime/help/plugins.md
View File

@@ -4,8 +4,6 @@ Micro supports creating plugins with a simple Lua system. Every plugin has a
main script which is run at startup which should be placed in
`~/.config/micro/plugins/pluginName/pluginName.lua`.
If you want to add a help page for your plugin, place a markdown file in `~/.config/micro/plugins/pluginName/help.md`.
There are a number of callback functions which you can create in your
plugin to run code at times other than startup. The naming scheme is
`onAction(view)`. For example a function which is run every time the user saves
@@ -111,6 +109,16 @@ The possible methods which you can call using the `messenger` variable are:
If you want a standard prompt, just use `messenger.Prompt(prompt, "", 0)`
# Adding help files, syntax files, or colorschemes in your plugin
You can use the `AddRuntimeFile(name, type, path string)` function to add various kinds of
files to your plugin. For example, if you'd like to add a help topic and to your plugin
called `test`, you would create the `test.md` file for example, and runt the function:
```lua
AddRuntimeFile("test", "help", "test.md")
```
# Autocomplete command arguments
See this example to learn how to use `MakeCompletion` and `MakeCommand`