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

44 lines
1.5 KiB
Markdown

---
layout: page
title: Octopress Documentation
date: July 18 2011
sidebar: false
comments: false
footer: false
---
Octopress is a framework designed for Jekyll, the static blogging engine powering Github Pages. So what is Jekyll?
{% blockquote Jekyll Wiki https://github.com/mojombo/jekyll/wiki/Usage %}
Jekyll at its core is a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed on the layout and more.
{% endblockquote %}
## Getting Started
- [Initial setup](/docs/setup) - Get source and install dependencies
- [Basic Configuration](/docs/configuring) - A descriptive list of configurations
- [Deploying Octopress](/docs/deploying) - Simple deploy instructions for Rsync and Github pages
## Using Octopress
- [Blogging Basics](/docs/blogging)
- [Sharing Code Snippets](/docs/blogging/code)
- [Syntax Highlighting Test](/docs/blogging/code/test)
- [Blogging With Plugins](/docs/blogging/plugins)
- TODO [Theming & Customization](/docs/theming)
- TODO [Updating](/docs/updating)
## Octopress Plugins - Usage & Examples
- Code Block
- Include Code
- Gist Tag
- Render Partial
- Figure Tag
- Blockquote
- Pullquote
- Custom filters
- Sitemap Generator
- Category Generator
- Compass Compiler
- Haml Converter
- Pygments Cache
- Titlecase