Octopress is a framework designed for Jekyll, the static blogging engine powering Github Pages. Have a look through the documentation and if you have trouble, I’ll be happy to help. If you find errors post an issue or fork and send a pull request on the site branch.

Note: If you already have a blog, check out Jekyll’s Migration page to help you get your current blog set up for Octopress blogging.

Getting Started

This section will help you get set up, and explain how to configure Octopress for your site.

• Initial setup - get source and install dependencies
• Basic Configuration - enable third party services and personalize your blog

Using Octopress

Your blog should be awesome. This should help.

• Blogging Basics - how to create blog posts and pages
• Deploying Octopress - simple deploy instructions for Rsync and Github pages
• Sharing Code Snippets - share code snippets with ease
• Blogging With Plugins - overview of plugins for blogging
• Theming & Customization - guide to making changes to your Octopress theme
• Updating Octopress - a guide to help you stay current with Octopress

Octopress Plugins - Usage & Examples

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 - easily post images with class names and titles
• Github Style codeblock - for simple lightweight code sharing
• Code Block - for sharing code with titles and links
• Include Code - embed code from your filesystem with a download link
• Gist Tag - automatically downloads and embeds Github gists
• Image Tag - easily post images with class names and titles
• Render Partial - insert any file into another post or page
• Blockquote - generate beautiful, semantic block quotes
• Pullquote - generate CSS only pull quotes — no duplicate data, no javascript
• Category Generator - generates archive pages for each blog category
• Include Array - includes an array of partials specified in the _config.yml

The following filters are used by Octopress, and are documented as necessary in their source.

• Octopress filters - liquid filters built just for Octopress
• 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 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