This tiddlywiki showcase how you can create, edit and publish your plugins in one click, from tiddlyhost, without any extra tools!
FAQ
-
How to install the library?
Drag and drop this link in your wiki to install this plugin library.
-
How can I create my own tiddlyhost plugin library ?
Clone this wiki to create your own tiddlyhost plugin library. You must allow the wiki to be loaded inside an iframe; otherwise, it will not work:
You can provide feedback and ask for help on Talk TiddlyWiki.
Please note: while this is one of the easiest way to create a plugin library, since everything is contained into one file, the more plugins you add to the library, the slower it will become. If this become an issue, use the standard plugin library setup.
-
How to create a plugin ?
Creating a plugin with the packager
- Open the packager
- Fill the form
- Click on the button to package or update the plugin
If you need a more advanced tool, use gatha.
Creating a plugin manually
- Create your tiddlers. Use the same prefix for each tiddlers if possible, e.g : $:/plugins/theophile.dev/tiddlyhostpluginlibrary
- Drag and drop the tiddlers in another wiki, for example https://tiddlywiki.com/empty
- This will open the
$:/Importtiddler. Do not click on the "import" button. Instead, edit it - Rename it with the prefix you choose for your tiddlers
- Set the value of the field
plugin-typetoplugin - Remove the field
status - Add a
listfield. Tiddlers with the plugin prefix + the names in the list field will be displayed on the plugin UI, e.g : $:/plugins/theophile.dev/tiddlyhostpluginlibrary/readme - Add a field "version". You can set it to the tiddlywiki version your plugin is compatible with for example.
- Confirm your changes, then drag and drop the plugin in your plugin library
-
How does this work ?
The tag is used to insert the necessary JavaScript directly into the
<head>section of the TiddlyWiki file. You can view the code by visiting this URL:view-source:https://plugin-library.tiddlyhost.com(Ctrl + U).- When you click “Open plugin library,” TiddlyWiki sends a GET request to the library’s URL (e.g., https://tiddlywiki.com/library/v5.3.6/index.html for the official plugin library).
- The library responds with a list of available plugins (in this case, defined in the assetList tiddler)
- TiddlyWiki then displays this list to allow you to choose a plugin to install.
- When you select a plugin to install, TiddlyWiki makes another request, specifying the plugin. The library fetches the content of the plugin and sends it back to TiddlyWiki.
- Instead of fetching the plugin file from the same directory as the library, the script redirects to the JSON endpoint provided by Tiddlyhost.