Преглед изворни кода

Update theming docs and README a bit.

Brit Butler пре 11 година
родитељ
комит
dcf2db3ff4
2 измењених фајлова са 7 додато и 5 уклоњено
  1. 1 1
      README.md
  2. 6 4
      docs/themes.md

+ 1 - 1
README.md

@@ -56,4 +56,4 @@ your post
56 56
 ```
57 57
 
58 58
 ## Theming
59
-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.
59
+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).

+ 6 - 4
docs/themes.md

@@ -4,9 +4,10 @@ The theming support in coleslaw is very flexible and relatively easy
4 4
 to use. However it does require some knowledge of HTML, CSS, and how
5 5
 coleslaw processes content.
6 6
 
7
-To understand how coleslaw processes a blog, a look at the [overview][ovr]
8
-documentation may prove useful. This document will focus mainly on the
9
-template engine and how you can influence the resulting HTML.
7
+To understand how coleslaw processes a blog, a look at the
8
+[overview][ovr] and [hacking][hck] documentation may prove
9
+useful. This document will focus mainly on the template engine and how
10
+you can influence the resulting HTML.
10 11
 
11 12
 **NOTE**: Themes are not able to change the generated file names or the
12 13
 generated file structure on disk. They can change the resulting HTML, nothing more.
@@ -219,7 +220,8 @@ Good luck!
219 220
 
220 221
 As mentioned earlier, most files have a file name which is a slug of
221 222
 some sort. So if you want to create a link to a tag file you should
222
-do something like this: `<a href="${config.domain}/tags/{$tag.slug}">{$tag.name}</a>`.
223
+do something like this: `<a href="${config.domain}/tags/{$tag.slug}.{$config.pageExt}">{$tag.name}</a>`.
223 224
 
224 225
 [clt]: https://developers.google.com/closure/templates/
225 226
 [ovr]: https://github.com/redline6561/coleslaw/blob/master/docs/overview.md
227
+[hck]: https://github.com/redline6561/coleslaw/blob/master/docs/hacking.md