If you want to improve or update an existing recipe, please follow this guide.
We highly suggest that you implement and test your updates to the recipe inside Ferdium before implementing them into the recipe repository. This will save you time on debugging and repackaging the recipe later.
You can find the recipe source Ferdium uses at:
- Mac:
~/Library/Application Support/Ferdium/recipes/<recipe id>/ - Windows:
%appdata%/Ferdium/recipes/<recipe id>/ - Linux:
~/.config/Ferdium/recipes/<recipe id>
If you can't find the recipe's folder, please make sure that you have created a service inside Ferdium with that recipe - otherwise Ferdium will not load it into the folder
After changing the files in that folder, you can reload the service inside Ferdium using CTRL/CMD + R.
Simply fork https://github.com/ferdium/ferdium-recipes. You may also want to clone the repository to your computer to edit it locally.
Simply add your changes to the recipe inside this repository.
You'll need to increase the version number inside recipe's package.json.
Ferdium uses this version to determine if it should update the local copy of the recipe. If you do not increase the version number, no Ferdium user will get your updated recipe 😔
This might be the most important step of this guide. You'll need to run the pnpm lint:fix && pnpm reformat-files && pnpm package command to ensure that all validation checks are run.