From b351c926acadffa00a6cc9a914440a6a43a481c0 Mon Sep 17 00:00:00 2001
From: Brandon Mathis <brandon@imathis.com>
Date: Wed, 20 Jul 2011 11:04:40 -0400
Subject: [PATCH] updated docs

---
 source/docs/blogging/code/index.markdown | 49 +++++++++++++++++++++++-
 source/docs/blogging/index.markdown      |  2 +
 source/docs/configuring/index.markdown   |  1 -
 source/docs/deploying/index.markdown     |  1 -
 source/docs/setup/index.markdown         |  1 -
 5 files changed, 50 insertions(+), 4 deletions(-)

diff --git a/source/docs/blogging/code/index.markdown b/source/docs/blogging/code/index.markdown
index 2a405ee..ba86f3d 100644
--- a/source/docs/blogging/code/index.markdown
+++ b/source/docs/blogging/code/index.markdown
@@ -6,4 +6,51 @@ sidebar: false
 footer: false
 ---
 
-Awesomeness!
+Sharing code is important, and blogging about it should be easy and beautiful.
+That's why Octopress is packed with features to make blogging your code a breeze.
+Though Jekyll comes with support for [Pygments syntax highlighting](http://pygments.org),
+Octopress makes it way better. Here's how.
+
+- A Sass port of [Solarized syntax highlighting](http://ethanschoonover.com/solarized) created specifically for Octopress
+- Gist code embedding - by [Brandon Tilly](https://gist.github.com/1027674)
+- Insert code snippets from your filesystem with a download link.
+- Easy inline code blocks with `<figure>` and `<figcaption>` and optional download links.
+- Pygments caching - a [Jekyll community plugin](https://github.com/rsim/blog.rayapps.com/blob/master/_plugins/pygments_cache_patch.rb)
+- Table based line numbers added with javascript
+
+## Gist Code embedding
+All you need is the gist's id and you can easily embed it in your page. This actually downloads a cache of the gist and embeds it in a `<noscript>` tag for RSS
+readers and search engines, while still using Github's javascript gist embed code for browsers.
+
+    {{ "{% gist 996818" }} %}
+
+The output looks like this:
+
+{% gist 996818 %}
+
+If you have a gist with multiple files, you can include files one at a time by adding the name after the gist id.
+
+    {{ "{% gist 1059334 svg_bullets.rb" }} %}
+    {{ "{% gist 1059334 usage.scss" }} %}
+
+## Include Code Snippets
+Import files on your filesystem into any blog post as embedded code snippets with syntax highlighting and a download link.
+In the `_config.yml` you can set your `code_dir` but the default is `source/downloads/code`. Simply put a file anywhere under that directory and
+use the following tag to embed it in a post.
+
+    {{ "{% include_code javascripts/test.js" }} %}
+
+    # or with optional title
+    {{ "{% include_code Testing include_code javascripts/test.js" }} %}
+
+This includes a file from `source/downloads/code/javascripts/test.js`. By default the `<figcaption>` will be the filename, but you can add a title before the filepath if you like.
+Here's what it looks like:
+
+{% include_code Testing include_code javascripts/test.js %}
+
+## Inline Codeblocks
+You can also write blocks of code directly in your posts.
+
+{% codeblock %}
+Awesome sauce Is Awesome.
+{% endcodeblock %}
diff --git a/source/docs/blogging/index.markdown b/source/docs/blogging/index.markdown
index e6fa44e..72dd593 100644
--- a/source/docs/blogging/index.markdown
+++ b/source/docs/blogging/index.markdown
@@ -75,3 +75,5 @@ Like with the new post task, the default file extension is `markdown` but you ca
     ---
 
 The title is derived from the filename so you'll likely want to change that. This is very similar to the post yaml except it doesn't include categories, and you can toggle sharing and comments or remove the footer altogehter. If you don't want to show a date on your page, just remove it from the yaml.
+
+[Next, Sharing Code Snippets &raquo;](/docs/blogging/code)
diff --git a/source/docs/configuring/index.markdown b/source/docs/configuring/index.markdown
index 9713031..690baa8 100644
--- a/source/docs/configuring/index.markdown
+++ b/source/docs/configuring/index.markdown
@@ -3,7 +3,6 @@ layout: page
 title: Configuring Octopress
 date: July 19 2011
 sidebar: false
-comments: false
 footer: false
 ---
 
diff --git a/source/docs/deploying/index.markdown b/source/docs/deploying/index.markdown
index 1147bfb..53b47d0 100644
--- a/source/docs/deploying/index.markdown
+++ b/source/docs/deploying/index.markdown
@@ -3,7 +3,6 @@ layout: page
 title: Deploying Octopress
 date: July 18 2011
 sidebar: false
-comments: false
 footer: false
 ---
 
diff --git a/source/docs/setup/index.markdown b/source/docs/setup/index.markdown
index 3cd0195..67eb878 100644
--- a/source/docs/setup/index.markdown
+++ b/source/docs/setup/index.markdown
@@ -3,7 +3,6 @@ layout: page
 title: Octopress Setup
 date: July 18 2011
 sidebar: false
-comments: false
 footer: false
 ---