Developer Docs
Search
⌃K

Theme Introduction

A guide to modifying and building Themes for RapidWeaver
Before you start developing or modifying a theme, you need to make sure you have RapidWeaver 8.0 or newer installed. You can download the latest version of RapidWeaver here.
You’ll also need a text editor, Nova from Panic is great and provides syntax highlighting which makes reading large amounts of code infinitely easier.

Requirements

Anyone can build or modify a theme for RapidWeaver. You'll just need a basic understanding of HTML and CSS to get going.
  • RapidWeaver Classic or newer
  • A code editor (Nova or similar)
  • A JSON/Plist editor (Lexi or similar)

Example Theme

Download the Example.rapidweavertheme below. Once downloaded you can double-click to install it. If RapidWeaver is running, you'll need to restart it for the theme to become active.
example-rapidweavertheme.zip
223KB
Binary

Theme Structure

Once you have the theme installed, open RapidWeaver and create a new project. Find the Example theme in the Theme Browser, right-click on the theme preview and select Show Contents.
You can right-click any theme in the Finder and choose "Show Package Contents".
This will reveal a Contents folder in the finder, inside are all the files required to construct a RapidWeaver theme. You should have the following files:
  • Theme.plist - an XML file containing the name and details of the theme
  • index.html - layout template file (HTML)
  • styles.css - base stylesheet (CSS)
  • colourtag.css - colour style variations stylesheet (CSS)
  • js Folder - contains the required javascript for the theme
  • images Folder - where all images for the theme are placed
  • css Folder - theme variations CSS files are located here
  • preview_large.jpg - 800x950px image/logo of your theme displayed in the theme drawer.
An example of the contents of a Theme.