android.moparisthebest.org/source/docs/index.markdown

layout	title	date	sidebar	comments	footer
page	Octopress Documentation	July 18 2011	false	false	false

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.

Getting Started

• Initial setup - Get source and install dependencies
• Basic Configuration - A descriptive list of configurations
• Deploying Octopress - Simple deploy instructions for Rsync and Github pages

Using Octopress

• Blogging Basics - Creating blog posts and pages
• Sharing Code Snippets - Share code snippets with ease
• Syntax Highlighting Test - Language highlighting tests
• Blogging With Plugins - Overview of plugins for blogging
• TODO Theming & Customization - Guide to making changes to your Octopress theme
• TODO Updating - A guide to help you stay up to date

Octopress Plugins - Usage & Examples

• Code Block - For easy inline code sharing
• Include Code - Embed code from your filesystem
• Gist Tag - Automatically downloads and embeds Github gists
• Render Partial - Insert any file into another post or page.
• Figure Tag - Easily post images with semantic <figure> & <figcaption> elements
• Blockquote - Generate beautiful, semantic block quotes
• Pullquote - Generate CSS only pull quotes — no duplicate data, no javascript.
• Custom filters - Liquid filters built just for Octopress
• Category Generator - Generates archive pages for each blog category
• 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
• Titlecase - Required by several plugins to automatically generate proper title captalization