2011-07-19 22:28:48 -04:00
---
layout: page
title: Octopress Documentation
date: July 18 2011
sidebar: false
comments: false
footer: false
---
2011-07-22 17:49:01 -04:00
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 ](http://convore.com/octopress/support ). If you find errors
[post an issue ](https://github.com/imathis/octopress/issues ) or fork and send a pull request on the [site branch ](https://github.com/imathis/octopress/tree/site ).
2011-07-19 22:28:48 -04:00
## Getting Started
2011-07-22 18:36:49 -04:00
If you're using bundler and rvm, this should be a breeze.
2011-07-23 00:25:48 -04:00
2011-07-23 01:36:20 -04:00
- [Initial setup ](/docs/setup ) - *get source and install dependencies*
- [Basic Configuration ](/docs/configuring ) - *enable third party services and personalize your blog*
- [Deploying Octopress ](/docs/deploying ) - *simple deploy instructions for Rsync and Github pages*
2011-07-19 22:28:48 -04:00
## Using Octopress
2011-07-22 18:36:49 -04:00
Your blog should be awesome. This should help.
2011-07-23 00:25:48 -04:00
2011-07-23 01:36:20 -04:00
- [Blogging Basics ](/docs/blogging ) - *how to create blog posts and pages*
- [Sharing Code Snippets ](/docs/blogging/code ) - *share code snippets with ease*
- [Syntax Highlighting Test ](/docs/blogging/code/test ) - *language highlighting tests*
- [Blogging With Plugins ](/docs/blogging/plugins ) - *overview of plugins for blogging*
- TODO [Theming & Customization ](/docs/theming ) - *guide to making changes to your Octopress theme*
- TODO [Updating ](/docs/updating ) - *a guide to help you stay up to date*
2011-07-19 22:28:48 -04:00
## Octopress Plugins - Usage & Examples
2011-07-22 18:36:49 -04:00
{% render_partial docs/plugins/index.markdown %}