Skip to content

Commit

Permalink
Merge pull request #48 from mhadaily/patch-1
Browse files Browse the repository at this point in the history
Fix tips.mdx syntax error
  • Loading branch information
antoKeinanen authored Feb 28, 2024
2 parents 2d7de45 + 1c7c4b0 commit 4163754
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/plugindev/tips.mdx
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.

0 comments on commit 4163754

Please sign in to comment.