After first announcing Feather Wiki, one of the biggest complaints I heard from people who are used to TiddlyWiki was that Feather Wiki did not include search bar to quickly search your content! So once I got extensions in place, I decided to try my hand at making an extension that adds a search bar to the menu as an example of what you can do with Feather Wiki extensions. There are many improvements that can be made, but this is meant to be a proof of concept to encourage someone to make something better to share!
Installation #
To try out the full search extension, you can do one of the following things:
- Go to your Wiki Settings and add
to the "Custom Head" text area.<script src="https://feather.wiki/extensions/v1.8.x/full-search.js"></script> - Save the full search extension file to the same folder as your Feather Wiki file and add
to the "Custom Head" text area in Wiki Settings.<script src="./full-search.js"></script>- (This way requires that the
full-search.jsfile always remains in the same folder as your wiki file.)
- (This way requires that the
- Go to the source code for the extension, copy the code, and paste the whole script directly into the "Custom JS" text area in Wiki Settings.
After adding the extension code to your wiki, save your changes and reload the wiki. You will not be able to see the results until you save your wiki and re-load the file.
What it Does #
Once installed, the full search plugin will inject a search bar just below the "Save Wiki" button that provides an extremely rudimentary way to search content in your wiki's pages, powered by Fuse.js! Type your search into the box and press Enter to show a "Results" page with your search results.
Note: This search extension requires a connection to the internet because it loads Fuse.js from an external CDN. It is possible to modify the code to use a local version, but you will need to download the Fuse.js code and modify the extension yourself for that.
Other Languages #
This extension is available in the following other languages:
You can use the extension in an available language by adding _language-code before .js in any of the instructions above. For example, https://feather.wiki/extensions/v1.8.x/full-search_hu.js for Hungarian.
Previous Versions #
Starting with Version 1.8.0, extensions are now stored in paths that include the minor version number (i.e. extensions for version 1.8.0 are stored in extensions/v1.8.x/) to indicate that they are incompatible with lower version numbers. The version of this extension compatible with versions of Feather Wiki below 1.8.0 can still be found at https://feather.wiki/extensions/search.js, but the old version will no longer receive updates.