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.

Sign up for GitHub

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

Jump to bottom

Fix tips.mdx syntax error #48

Merged
merged 1 commit into from
Feb 28, 2024
Merged

Fix tips.mdx syntax error #48

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/plugindev/tips.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

We require a few conventions to standardize things and to avoid conflicts. These are as follows:

1. Plugin Name: Let's consider a plugin which provides authentication, named as Auth.
2. Class Name: The name of the class will be your plugin name suffixed with 'Plugin' i.e. AuthPlugin.
3. getPluginName: When returning the name of the plugin, we add <plugin_name> with @, followed by the version. ex : [email protected] (<plugin_name>@).
4. Adding functions: While functions can be added to pluginStore with any name, to ensure uniqueness across plugins, we recommend the format <plugin_name>.<function_name>. Ex : Auth.authenticate.
5. Events: Events can be added and dispatched from pluginStore using any name. To show which event belongs to which plugin, we recommend the format <plugin_name>.<event_name> Ex: Auth.checking.
1. Plugin Name: Let's consider a plugin named Auth that provides authentication.
2. Class Name: The name of the class will be your plugin name suffixed with 'Plugin', i.e., AuthPlugin.
3. getPluginName: When returning the name of the plugin, we add `<plugin_name>` with @, followed by the version. ex: [email protected] (`<plugin_name>@`).
4. Adding functions: While functions can be added to pluginStore with any name, we recommend the format `<plugin_name>.<function_name>` to ensure uniqueness across plugins. Ex: Auth.authenticate.
5. Events: Events can be added and dispatched from pluginStore using any name. To show which event belongs to which plugin, we recommend the format `<plugin_name>.<event_name>` Ex: Auth.checking.
Loading