diff --git a/README.md b/README.md index 96a5678..623a8a5 100644 --- a/README.md +++ b/README.md @@ -56,4 +56,4 @@ your post ``` ## Theming -A default theme, hyde, is provided. Themes are made using Google's closure-template and the source for [hyde](https://github.com/redline6561/coleslaw/tree/master/themes/hyde) should be simple and instructive until I can provide better docs. +Two themes are provided: hyde and readable (based on [bootswatch readable](http://bootswatch.com/readable/)). Hyde is the default. A guide to creating themes for coleslaw lives [here](https://github.com/redline6561/coleslaw/blob/master/docs/themes.md). diff --git a/docs/themes.md b/docs/themes.md index 27143a5..caa0035 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -4,9 +4,10 @@ The theming support in coleslaw is very flexible and relatively easy to use. However it does require some knowledge of HTML, CSS, and how coleslaw processes content. -To understand how coleslaw processes a blog, a look at the [overview][ovr] -documentation may prove useful. This document will focus mainly on the -template engine and how you can influence the resulting HTML. +To understand how coleslaw processes a blog, a look at the +[overview][ovr] and [hacking][hck] documentation may prove +useful. This document will focus mainly on the template engine and how +you can influence the resulting HTML. **NOTE**: Themes are not able to change the generated file names or the generated file structure on disk. They can change the resulting HTML, nothing more. @@ -219,7 +220,8 @@ Good luck! As mentioned earlier, most files have a file name which is a slug of some sort. So if you want to create a link to a tag file you should -do something like this: `{$tag.name}`. +do something like this: `{$tag.name}`. [clt]: https://developers.google.com/closure/templates/ [ovr]: https://github.com/redline6561/coleslaw/blob/master/docs/overview.md +[hck]: https://github.com/redline6561/coleslaw/blob/master/docs/hacking.md