Config Reference

Don't be scared off by this page! It's an advanced reference and the default settings will be fine for most Static Ultra webmasters.

If you're new to Static Ultra, I would suggest ignoring this page for now, and going through the tutorials, starting with Getting Started.

The config file is requested a-new every time a page is loaded, in order to make everything ELSE as cached and efficient as possible.

So, to keep the size of the config file to a minimum, I've taken out all the helper comments that used to be shipped with it, and linked to this page there instead.

Here is a full explanation of every config item:


SITE_VERSION (integer)

Your website version. You should update this whenever you've finished updating your website. While developing your site you don't need to update this and can use Ctrl+F5 to make sure Static Ultra fetches the latest resources


SITE_PATH (string)

Path from your domain to your website's root


SITE_TITLE_HTML (HTML string)

Site's title HTML. Saves you having to put it in every page/theme! You can put HTML here, so it's also a good place to put a logo


SITE_SLOGAN_ENABLE (true/false)
SITE_SLOGAN_HTML (HTML string)

Site's slogan HTML for a little info about your site that usually appears very near the site title. To disable, set enable to false, or slogan to empty string: ``


NOT_FOUND_PAGE (string)

Location of your not found/404 page. You can just leave this as-is on Neocities, on other hosts it should match the URL of... well... your not found page. :)


SITE_FOOTER_HTML (HTML string)

Site's footer HTML for copyright or whatnot. Can be HTML.


CUSTOM_HOME (string);

This is used for when you want a landing page, and for your actual home page NOT to be the default index.html. See Landing Pages.

MENU_ENABLE (true/false)
SITE_MENU (array)

Your site's main menu and whether it's enabled or not. Static Ultra will transform this into the equivalent HTML. See Adding Pages.


BREADCRUMB_ENABLE (true/false)

Whether or not to enable the breadcrumb (shows visitors where they are in the site).


BREADCRUMB_HINT (array)

Folders that contain Static Ultra pages. This is only needed to make the breadcrumb work, but it's recommended to keep it up to date in case future Static Ultra features depend on it. See Adding Folders.


SITE_SHEETS (array)

These are your site-wide CSS files that you want Static Ultra to load on every page regardless of theme. You might wanna pop your CSS reset or third party CSS framework here! See CSS Guide.


SITE_SCRIPTS (array)

Same as above, but JS. See JS Guide.


THEME_IDS (array)

Themes you have installed on your site (located in the "themes" folder) See Creating Themes and Free Themes.


THEME_DEFAULT_ID (string)

Which theme your site should use by default if the visitor hasn't switched themes and the page hasn't forced a different one. Or if the active theme fails to load. See Creating Themes and Free Themes.


THEME_SWITCHING_ENABLE (true/false)

Whether or not to allow visitors to switch themes.


EXTENSIONS (array)

Extensions you have installed on your site. See Creating Extensions and Get Extensions.


ICON "string"

If this is not blank, Static Ultra will load this graphic as your site's icon. Path is relative to site root. No leading "/" needed.


SITE_ID (string)

Site ID. You only need to change this if you want to have multiple Static Ultra sites on the same domain. Can be made of letters, numbers, and underscores (no spaces).


ENABLE_CHECK_FOR_NO_HTML_URL (true/false)

"Some web hosts", e.g. Neocities, have a policy of redirecting files with a .html extension to the same URL without .html. So, if you visit "hello.html" on a Neocities website, you will be redirected to just "hello". When the above is true or omitted, Static Ultra will remove .html from URLs with .html in them and attempt to load that first, if that fails it will go back to normally requesting the URL. So in short you should set this to false on non-Neocities hosts that don't do the redirect for a tad extra speed, and leave it as true on Neocities.


DEV_MODE (true/false)

This is just for Static Ultra development purposes. You're best off leaving it false. When true, Static Ultra's classes are loaded from separate files rather than the merged version, which is not suitable for a live website due to speed, but useful for development purposes