Skip to content
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

Improve loadPlugin api docs to reflect usage with github repos #511

Open
jmetz opened this issue Feb 14, 2024 · 0 comments
Open

Improve loadPlugin api docs to reflect usage with github repos #511

jmetz opened this issue Feb 14, 2024 · 0 comments

Comments

@jmetz
Copy link

jmetz commented Feb 14, 2024

The api docs here: https://imjoy.io/docs/#/api?id=apiloadplugin don't mention github or the syntax mentioned elsewhere ( https://imjoy.io/docs/#/development?id=generating-a-plugin-url-for-sharing) for how loadPlugin can be used to load a plugin from a github repo using just username/repo:plugin-name syntax.

There also seem to be no corresponding jsdoc (or requiring a larger refactor, typedoc or similar) method for generating the API section of the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant