Feather Wiki

A tiny tool for simple, self-contained wikis!

Learn /

Wiki Settings

The Wiki Settings page, accessed via the link in the menu, allows you to:

  1. Set your wiki's title and description,
  2. Set your wiki's home page,
  3. Set the order your pages appear around your wiki,
  4. Set custom CSS to change the look of your wiki,
  5. Add custom JavaScript to infinitely extend your wiki,
  6. Add any custom HTML to the head of your wiki for enhanced SEO capabilities,
  7. Optionally include the content of your wiki as HTML in your save,
  8. Mark your wiki as "published" to hide edit buttons,
  9. Import an existing Feather Wiki file to overwrite your current session, and
  10. View and manage images you have inserted into your Feather Wiki.
Please note: Even after you update your wiki's settings, you must click the "Save Wiki" button to make your changes permanent!

1. Title & Description #

Your Wiki Title and Wiki Description appear on the top left side of your wiki. A title is required for your wiki, and clicking it will take you to your wiki's home page. A description is optional, and if the Wiki Description field is left blank, it will simply not display.

2. Home Page #

Once you Create a Page in your wiki, you can choose that page to be the first thing that loads when visiting your wiki. By default, the home page will display all of your wiki's pages with parent and child pages nested appropriately, but you can specify any page of your wiki to be the home page, even if it is a child of another page.

3. Page Order #

If your pages aren't sorting correctly in the menu, the All Pages list, or in a parent page's "Sub Pages" section, you can use this to manually set the order your pages appear. When the Wiki Settings page loads, it will display the current sort order of your pages. Placing one slug per line, you can re-organize this list however you'd like.

When you're done organizing your pages, be sure to click the Update button to see your page order updated, and make sure you save your wiki to make your reordering permanent! Also note that if you delete or misspell a slug in the page order list, then those pages will be moved to the top of the list when you update your settings (this can also be a helpful way to find slugs you mistakenly deleted while editing).

4. Custom CSS #

If you're savvy with your browser's inspector, want to change how your wiki looks, the Custom CSS field lets you enter any CSS you want! There's not a lot more to say here, just make sure that your CSS is valid and that you don't put any HTML in this field or else you'll mess things up for yourself. Also be aware that your custom CSS will not be minified and may make your resulting wiki slightly larger as a result.

5. Custom JavaScript #

Feather Wiki offers the ability to extend your wiki nearly infinitely. Any JavaScript code you write in this "Custom JS" field will be added to a <script> tag specifically for making your wiki function exactly how you want it to. This JavaScript is automatically wrapped in a special function that ensures that it runs after Feather Wiki's core code is ready so you can more reliably alter its core code. More information on extending your wiki will be available on the Extensions page.

6. Custom Head #

As of version 1.5.0, Feather Wiki allows you to add arbitrary HTML to your Feather Wiki's head. Add things like meta tags or even additional script beyond what the Custom JavaScript allows! This can be helpful for adding things like extra data required to improve search engine optimization for your site and add more explicit references to favicons.

7. Include Static HTML #

By default, Feather Wiki includes a table of contents of your wiki's pages in the static HTML so devices that do not support JavaScript can see what the document contains. Checking the "Include Static HTML" button makes Feather Wiki include all of your wiki's content as static HTML so it can be viewed in its entirety by devices that cannot load Feather Wiki's full JavaScript app. Any custom styling is still applied to the HTML, but you cannot (easily) edit the content if the JavaScript is not run, and all of your wiki pages are displayed one after the other.

Please note that while this is great for accessibility, it will nearly double the size of your wiki, because your content is duplicated in its HTML form.

8. Publishing #

Checking the "Publish" box will hide all of the buttons that enable modifying your wiki. This includes the "Wiki Settings" link, the "New Page" button, the "Edit" buttons on wiki pages, and the "Save Wiki" button. When this box is checked and you click the "Update" button, the specified buttons will only be visible on the Wiki Settings page, which can still be visited manually by adding ?page=s after the .html part of your URL. (Clicking that link will take you to the Wiki Settings page for this wiki!)

View Publishing for some tips on how to make your Feather Wiki public.

9. Import & Overwrite (Upgrading) #

This button is intended to be used to upgrade a Feather Wiki that was created using an older version to a new version. It accomplishes this by loading an old Feather Wiki's HTML file, grabbing the data, and overwriting the current session with that old data. Once loaded, you can click the "Save Wiki" button to save your old data in the new version of Feather Wiki!

Be aware that this is instantaneous once loaded, but it will only overwrite your existing data if you specifically choose to save the download in a way that overwrites the old file.

10. Manage Inserted Images #

If you choose the option to insert an image from a file (the 📸 icon in the page editor), Feather Wiki will store that image as data in your HTML file in a way that makes it re-usable. You can view the images you have added this way from the "Existing Images" section of the Wiki Settings page. This section allows you to view image, its alt text, and its dimensions and gives you buttons to view the full-size image, edit the alt text, delete the image, or see what pages the image is used in.

If you choose to delete the image, it will also remove the image from all pages it is used in, if any, so please be cautious with this action. Note, however, that your image will not truly be lost unless you choose to overwrite the original Feather Wiki HTML file with the newly saved version.