Feather Wiki

A tiny tool for simple, self-contained wikis!

Extensions /

Toggle Menu

Created:

Sometimes you want a nice, clean page with no menu or navigation... I guess? I'm not completely sure why, but this extension has been requested a few times in the past. Anyway, this extension lets you hide the sidebar menu when you're not on a mobile-sized screen.

Installation #

To use the toggle menu 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/toggle-menu.js"></script>
    to the "Custom Head" text area.
  • Save the toggle menu extension file to the same folder as your Feather Wiki file and add
    <script src="./toggle-menu.js"></script>
    to the "Custom Head" text area in Wiki Settings.
    • (This way requires that the toggle-menu.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.

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 you will see a small arrow at the top of the window on the right side of the main menu sidebar. Click it, and the sidebar menu will disappear and the arrow in the button will change direction! Click it again, and the sidebar menu will reappear.

Note: The toggle button only appears on screens large enough to display the sidebar on the left side of the screen—it will not display on narrow mobile screens.

Setting Defaults #

  • If you want, you can set your sidebar to be hidden by default by adding window.toggleSidebarHiddenDefault = true; to the "Custom JS" text area in Wiki Settings.
  • If for some reason you really don't want to be able to navigate your wiki at all, you can also hide the toggle button so only the content of the displayed page is visible by adding window.toggleSidebarButtonHidden = true; to the "Custom JS" text area in Wiki Settings in addition to the setting above.

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