Configuring the Wikidot API

Created: 1304262063|%e %B %Y, %H:%M|agohover by Ed Johnson, Last updated: 1305856074|%O ago by leiger. History

In order to configure the Wikidot API setting in STE, you must:

  1. Hit the "F4" key or choose Edit > Settings… from the menu. (For Mac OS X, use ⌘+comma or Edit > Preferences…)
  2. Click the Wikidot API tab in the settings dialog box.

The default settings (pictured above) will allow you to preview your pages without any other configuration. However, the real power of STE is in the ability to import, edit, and export pages directly from the editor. In order to use these features, you must have your own API key. See the official Wikidot Developer Site for details on acquiring your API key if you don't currently have one.

Check the "Use a private Wikidot account" box to use and configure your personal API key.


Default Settings


To access your Wikidot sites you will need to prove your identity. You do this by giving STE your personal API key. You can find this key on your account setting page under My Account > Settings > API access.


Copy the key from your account settings and paste it into the STE input box like so:


API keys masked to protect the innocent

Document preview

The two input boxes in this section require, in order, the following:

  1. The unix name of a site that you are a member of. This can be taken from the URL of the site. For example, in the my-site part is the unix name of the site.
  2. The name of a page on the site to be used to hold the previews generated by STE. For example, ste-preview. If the page does not exist, it will be created after you preview your first page.

Example using your own site and page name

Note: If you are using your Wikidot API key, you must change the preview settings to one of your own sites or the preview feature will stop working.

Preview CSS theme

This section holds the CSS that you want to use in the preview window. This is an external URL pointing to the CSS file. Due to some limitations in how compatible the CSS is, the default setting should be fine for most users.

Preview Example


Preview in Browser Example

Unless otherwise stated, the content of this page is licensed under Creative Commons Attribution-ShareAlike 3.0 License