README.textile in jekyll-0.1.5 vs README.textile in jekyll-0.1.6
- old
+ new
@@ -58,9 +58,46 @@
$ jekyll /path/to/proto/site /path/to/place/generated/site
The autobuild feature can be used on any of the invocations.
+h2. Filters, Tags, and Blocks
+
+h3. Include Tag
+
+If you have small page fragments that you wish to include in multiple places on your site, you can use the <code>include</code> tag.
+
+<pre>{% include sig.textile %}</pre>
+
+Jekyll expects all include files to be placed in an <code>_includes</code> directory at the root of your source dir. So this will embed the contents of <code>/path/to/proto/site/_includes/sig.textile</code> into the calling file.
+
+h3. Code Highlighting Block
+
+Jekyll has built in support for syntax highlighting of over "100
+languages":http://pygments.org/languages/ via "Pygments":http://pygments.org/.
+In order to take advantage of this you'll need to have Pygments installed (and
+the pygmentize binary must be in your path).
+
+To denote a code block that should be highlighted:
+
+<pre>
+{% highlight ruby %}
+def foo
+ puts 'foo'
+end
+{% endhighlight %}
+</pre>
+
+The argument to <code>highlight</code> is the language identifier. To find the
+appropriate identifier to use for your favorite language, look for the "short
+name" on the "Lexers":http://pygments.org/docs/lexers/ page.
+
+In order for the highlighting to show up, you'll need to include a
+highlighting stylesheet. For an example stylesheet you can look at
+"syntax.css":http://github.com/mojombo/tpw/tree/master/css/syntax.css. These
+are the same styles as used by GitHub and you are free to use them for your
+own site.
+
h2. Contribute
If you'd like to hack on Jekyll, grab the source from GitHub. To get
all of the dependencies, install the gem first.