From ef0286bcc1a9832feb3e36b5c1723d499fc850cc Mon Sep 17 00:00:00 2001 From: Laurent Cozic Date: Thu, 3 Nov 2022 20:13:52 +0000 Subject: [PATCH] Doc: Fixed Markdown title --- readme/spec/default_plugins.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/readme/spec/default_plugins.md b/readme/spec/default_plugins.md index 7171544948..6dec9ecd3f 100644 --- a/readme/spec/default_plugins.md +++ b/readme/spec/default_plugins.md @@ -1,4 +1,4 @@ -## How to add a new default plugin +# How to add a new default plugin To add a new default plugin for desktop: - Add the plugin ID and pinned version to `defaultPlugins` object located in [desktopDefaultPluginsInfo.ts](https://github.com/laurent22/joplin/blob/eb7083d7888433ff6ef76ccfb7fb87ba951d513f/packages/lib/services/plugins/defaultPlugins/desktopDefaultPluginsInfo.ts#L5) @@ -19,6 +19,7 @@ To add a new default plugin for desktop: ``` ## Bundling of default plugins + Script for bundling default plugins is present in [bundleDefaultPlugins.ts](https://github.com/laurent22/joplin/blob/eb7083d7888433ff6ef76ccfb7fb87ba951d513f/packages/tools/bundleDefaultPlugins.ts) Every time a new desktop release is being built, we compare the local default plugins version with pinned plugin version mentioned in [desktopDefaultPluginsInfo.ts](https://github.com/laurent22/joplin/blob/eb7083d7888433ff6ef76ccfb7fb87ba951d513f/packages/lib/services/plugins/defaultPlugins/desktopDefaultPluginsInfo.ts) @@ -26,6 +27,7 @@ Every time a new desktop release is being built, we compare the local default pl If there is a newer version available, we will pull the `tgz` file of plugin from NPM registry and extract it. We will then move `manifest.json` and `plugin.jpl` to the build folder of desktop. ## Installing of default plugins + - All the functions related to default plugins are located in [defaultPluginsUtils.ts](https://github.com/laurent22/joplin/blob/eb7083d7888433ff6ef76ccfb7fb87ba951d513f/packages/lib/services/plugins/defaultPlugins/defaultPluginsUtils.ts) - On every startup, we check if there are new plugins available in build folder that have not been installed yet. After installing the new plugin, we update the `installedDefaultPlugins` array in `Setting.ts` with respective plugin ID for future reference. - After installing is complete, we apply the default settings for each default plugin. Default settings are located in [desktopDefaultPluginsInfo.ts](https://github.com/laurent22/joplin/blob/eb7083d7888433ff6ef76ccfb7fb87ba951d513f/packages/lib/services/plugins/defaultPlugins/desktopDefaultPluginsInfo.ts)