-
-
Notifications
You must be signed in to change notification settings - Fork 798
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Added new Docs page to describe Plugins. #6188
base: main
Are you sure you want to change the base?
Conversation
WIP for review TODO: 1. Add a section to the reference for `wezterm.plugins` 2. Create a plugin starter project wez#6177
1. Remove references to my specific example repo 2. Improve Lua code
There are some details described in the docs included in #5820 about the names derived from the url, which might be useful for this PR |
Thanks fot the review @MLFlexer -- much appreciated. I assume you are referring to the URL encoding to derive the plugin dir? I did consider that, but decided it was easier to leave it out. It's not really needed as users and developers can use list function to get the plugin location. Also one less thing to update if it changes in the future. Is there some use case I have not considered? Cheers |
The only thing I as a plugin developer could have benefited from was knowing how the directory name was computed, as it is useful for adding sub-modules to the plugins via. adding the plugin directory to the lua path. However thinking more about it, I agree that it should be left out, as it does not provide a good solution to the sub-module problem anyways. I'm also of the belief that the docs should be keeps simple, stupid, as to keep them readable and to not confuse others. So I agree with leaving it out. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, there are some very nice examples and tips which would have helped me when developing plugins 😄
86779c6
to
5f0ceb2
Compare
TODO:
Add a section to the reference forwezterm.plugins
#6177