Theme Structure - getscissorhands/Scissorhands.NET GitHub Wiki

Theme determines the appearance of your website. It contains several components – HTML templates, images, CSS files and JavaScript files.

Components

Each theme package MUST contain at least the following two files.

• theme.json
• index.html

Following files are all optional. If any of them exists, index.html will replace the corresponding placeholder with them.

• post.html
• page.html
• _header.html
• _footer.html
• _sidebar.html

theme.json

This contains all metadata of the theme.

{
  "id": "Unique ID of the theme",
  "version": "Version of the theme",
  "name": "Name of the theme",
  "description": "Description of the theme",
  "projectUrl": "URL for the theme project",
  "licenseUrl": "URL for the theme",
  "iconUrl": "URL for the icon of the theme",
  "author": {
    "name": "Name of the author",
    "email": "Author's email",
    "social": {
      "twitter": "Twitter account",
      "facebook": "Facebook account",
      "googlePlus": "Google+ account",
      "linkedIn": "LinkedIn account"
    }
  }
}

index.html

This is the main file that is processed by Scissorhands.NET.

post.html

This will be replaced with the placeholder, {render:post.html} in index.html.

page.html

This will be replaced with the placeholder, {render:page.html} in index.html.

_header.html

This will be replaced with the placeholder, {render:_header.html} in index.html.

_footer.html

This will be replaced with the placeholder, {render:_footer.html} in index.html.

_sidebar.html

This will be replaced with the placeholder, {render:_sidebar.html} in index.html.

File Locations

Scissorhands.NET does not have a strong restriction where the images, CSS files and JavaScript files are located, but those locations are recommended as a convention.

Images

Scissorhands.NET does not recommend storing images within the repository. Instead, any image hosting service such as imgur, imageshack, flickr, Dropbox, Google Drive, or OneDrive would be recommended.

However, if you really want to store images within the repository, the images directory is recommended.

Static Files

Scissorhands.NET does not recommend storing static files within the repository. Instead, any storage service such as Dropbox, Google Drive, or OneDrive would be recommended.

However, if you really want to store those static files within the repository, the contents directory is recommended.

CSS Files

The css directory is recommended.

JavaScript Files

The js directory is recommended.