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

allow plugins to have a help file

Browse Source
This commit is contained in:
boombuler
2016-09-13 09:06:06 +02:00
parent a7f159bddc
commit d250b9d7b0
3 changed files with 24 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
runtime/help/plugins.md
View File

@@ -4,6 +4,8 @@ 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