Feather Wiki

A tiny tool for simple, self-contained wikis!

Extensions /

SunEditor Replacement

Created:

If you want a more powerful visual text editor for Feather Wiki that gives a better writing experience at the cost of a larger file load size, you can use this extension to replace the default HTML editor with SunEditor.

This extension was made by jcoder and the source code can be found in their repository on Codeberg.

Installation #

To use the SunEditor extension, you can do one of the following things:

  • Go to your Wiki Settings and add 
    <script src="https://feather.wiki/extensions/v1.8.x/suneditor-replacement.js"></script>
    to the "Custom Head" text area.
  • Save the SunEditor extension file to the same folder as your Feather Wiki file and add 
    <script src="./suneditor-replacement.js"></script>
    to the "Custom Head" text area in Wiki Settings.
    • (This way requires that the suneditor-replacement.js file always remains in the same folder as your wiki file.)
  • 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.

What it Does #

Once you add your extension code, you will not be able to see the results until you save your wiki and re-load the file. When it's saved and reloaded, the SunEditor extension will replace the default Feather Wiki editor with the most recent version of SunEditor whenever you create a new page or edit an existing one.

Note: This extension requires a connection to the internet because it loads SunEditor from an external CDN. It is possible to modify the code to use a local version, but you will need to download the suneditor.min.css and suneditor.min.js code from the SunEditor repository and modify the extension yourself for that.

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/suneditor-replacement.js, but the old version will no longer receive updates.