From 14a0f8f9c63eac4d21948351bb5135a0c1bbd436 Mon Sep 17 00:00:00 2001 From: Brandon Mathis Date: Wed, 27 Jul 2011 00:18:46 -0400 Subject: [PATCH] added more documentation for github backtick highlighted code blocks --- source/docs/blogging/code/index.markdown | 3 +++ source/docs/plugins/index.markdown | 7 ++++--- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/source/docs/blogging/code/index.markdown b/source/docs/blogging/code/index.markdown index abd70a5..52fd2d5 100644 --- a/source/docs/blogging/code/index.markdown +++ b/source/docs/blogging/code/index.markdown @@ -28,6 +28,9 @@ them to the Vim rendered versions. Check out the [test page](/docs/blogging/code/test) to see the results. +## Github Style Code Blocks +{% render_partial docs/plugins/github-style-codeblock/index.markdown %} + ## Gist Embedding {% render_partial docs/plugins/gist-tag/index.markdown %} diff --git a/source/docs/plugins/index.markdown b/source/docs/plugins/index.markdown index dfa97d3..cb98f68 100644 --- a/source/docs/plugins/index.markdown +++ b/source/docs/plugins/index.markdown @@ -10,8 +10,9 @@ footer: false Octopress ships with the following plugins. Many have been written specially for Octopress, but some have been selected from the Jekyll community with various changes and improvements. - [HTML5 Video Tag](/docs/plugins/video-tag) - *easily post images with class names and titles* -- [Code Block](/docs/plugins/codeblock) - *for easy inline code sharing* -- [Include Code](/docs/plugins/include-code) - *embed code from your filesystem* +- [Github Style codeblock](/docs/plugins/github-style-codeblock) - *for simple lightweight code sharing* +- [Code Block](/docs/plugins/codeblock) - *for sharing code with titles and links* +- [Include Code](/docs/plugins/include-code) - *embed code from your filesystem with a download link* - [Gist Tag](/docs/plugins/gist-tag) - *automatically downloads and embeds Github gists* - [Image Tag](/docs/plugins/image-tag) - *easily post images with class names and titles* - [Render Partial](/docs/plugins/render-partial) - *insert any file into another post or page* @@ -25,7 +26,7 @@ The following filters are used by Octopress, and are documented as necessary in - Sitemap Generator - *generates an SEO friendly sitemap.xml* - Compass Compiler - *forces Jekyll to compile Compass on each load* - Haml Converter - *allows .haml pages to be processed by Jekyll* -- Pygments Cache - *caches code snippets to speed up Jekyll processing* +- Pygments Code - *converts code snippets to highlighted code and caches to speed up Jekyll processing* - Titlecase - *required by several plugins to automatically generate proper title captalization* [Octopress plugins source](https://github.com/imathis/octopress/tree/master/plugins)