feat: add documentation for plugins#422
Open
Nerixyz wants to merge 5 commits into
Open
Conversation
✅ Deploy Preview for chatterino-wiki-dev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Nerixyz
force-pushed
the
feat/plugin-docs
branch
from
f916dbc to
9d5ab89
Compare
Mm2PL
reviewed
Dec 4, 2024
Mm2PL
left a comment
Mm2PL
left a comment
Collaborator
There was a problem hiding this comment.
I would like a notice in the main plugin info page that APIs may still be subject to change or other reworks and thus plugins may stop working rather unexpectedly until APIs are finalized.
Mm2PL
reviewed
Dec 4, 2024
| @@ -0,0 +1,388 @@ | |||
| -- | |||
Collaborator
There was a problem hiding this comment.
Ideally we wouldn't need to redistribute a JSON library and would just have JSON support in the client.
pajlada
approved these changes
Jan 21, 2025
Mm2PL
requested changes
Jan 21, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This adds some basic documentation for plugins. It doesn't add a full reference for the API, as that's hard to keep synced (maybe we could do this automagically in the future?). It contains a larger example for a weather plugin that uses a free API. Initially, I thought about a translation plugin, but the decent translation APIs all require an API key.
The Lua syntax highlighting is a bit poor, because most things are just
Name(instead ofName.Variable/.Function/.Property).