Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
An elegant, flexible WordPress theme
PHP JavaScript Ruby

This branch is 1 commit ahead, 205 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
headers
images
library
styles
.gitignore
404.php
CHANGELOG
COPYRIGHT
README.md
archive.php
archives.php
comments.php
footer.php
functions.php
header.php
index.php
links.php
loop.php
screenshot.png
search.php
searchform.php
sidebar.php
style.css
tags.php

README.md

Tarski

Tarski is an elegant, flexible WordPress theme developed by Benedict Eastaugh. As a WordPress extension it is licensed under the GPL; please consult the COPYRIGHT file that should have been provided with this README for more details.

Installing

Tarski is installed like any other WordPress theme: upload the files to the wp-content/themes directory of your WordPress installation, and activate it from the Appearance page in your WordPress admin panel.

Customising

Tarski provides its own options page, allowing for the easy customisation of a number of aspects of the theme. Just go to the Tarski options page in the Appearance section of your WordPress admin panel and adjust the settings.

Extending

Apart from the options which Tarski supports two basic extension mechanisms: plugins and child themes. Both of these are provided by WordPress, but Tarski improves upon them in several ways, firstly by providing a larger repertoire of API hooks which plugins can use, and secondly by allowing users to select alternate styles and header images from child themes as well as Tarski itself.

Child themes

Tarski's extensive API and large library of utility functions, allied to the customisability provided by its options page, makes it an excellent base for building WordPress child themes.

Writing plugins

Tarski's theme hooks API is an extension of the basic WordPress hooks API, and allows for major modifications to be made to almost every aspect of the theme's functionality. Writing Plugins for Tarski explains the process of creating a plugin that modifies some aspect of Tarski, while the Hooks Reference is a complete API reference. A library of example plugins rounds out the documentation with example code.

Contributing

Tarski relies on contributions from the community. The main areas of activity are: reporting bugs; creating and updating translations; building child themes; writing plugins; and lastly, improving the theme itself.

Reporting bugs

Bugs should be reported on the Tarski issue tracker. If you're not sure whether the behaviour you're observing is caused by Tarski or WordPress, or whether it's intentional or not, please post on the Tarski forum. Security issues should be reported directly to Benedict.

Translations

There are a large number of translations already available for Tarski, but new and updated localisation files are always welcome. Please see the localisation page for more details.

Core contributions

If you want to contribute directly to the core Tarski code, please fork the project on GitHub, make your changes in a topic branch and send a pull request. Contributions are particularly welcome in the following areas:

  • Improving the hooks documentation
  • Auditing the code for potential security issues
  • Suggesting API extensions and improvements

Happy hacking!

Something went wrong with that request. Please try again.