updated documentation

This commit is contained in:
Brandon Mathis 2011-07-23 01:36:20 -04:00
parent 4a157d5757
commit 4c4adda2b1
11 changed files with 63 additions and 39 deletions

View File

@ -27,6 +27,7 @@ destination: public
plugins: plugins plugins: plugins
code_dir: downloads/code code_dir: downloads/code
category_dir: blog/categories category_dir: blog/categories
category_title_prefix: "Category: "
markdown: rdiscount markdown: rdiscount
pygments: false pygments: false

View File

@ -1,3 +1,5 @@
li { em { color: mix($text-color-light, $text-color); }}
@include font-face("Bebas-Neue", font-files("bebasneue-web.woff", woff, "bebasneue-web.ttf", truetype, "bebasneue-web.svg#BebasNeueRegular", svg), $eot: "bebasneue-web.eot" ); @include font-face("Bebas-Neue", font-files("bebasneue-web.woff", woff, "bebasneue-web.ttf", truetype, "bebasneue-web.svg#BebasNeueRegular", svg), $eot: "bebasneue-web.eot" );
body > header h1 { body > header h1 {

View File

@ -14,4 +14,5 @@
<li><a href="{{ root_url }}/">Blog</a></li> <li><a href="{{ root_url }}/">Blog</a></li>
<li><a href="{{ root_url }}/docs">Documentation</a></li> <li><a href="{{ root_url }}/docs">Documentation</a></li>
<li><a href="http://github.com/imathis/octopress">Source</a></li> <li><a href="http://github.com/imathis/octopress">Source</a></li>
<li><a href="http://convore.com/octopress/support">Support</a></li>
</ul> </ul>

View File

@ -9,6 +9,18 @@ footer: false
There are [other plugins](/docs/plugins) for octopress, but here's an overview of the ones you'll be likely to use while blogging. There are [other plugins](/docs/plugins) for octopress, but here's an overview of the ones you'll be likely to use while blogging.
This is mainly a description and demo, so be sure to follow the links beneath each section for examples and documentation. This is mainly a description and demo, so be sure to follow the links beneath each section for examples and documentation.
## Excerpt Filter
When writing a post, you can add an HTML comment `<!--more-->` to split the post for an excerpt. Only the first section of the post, before the comment,
will show up on the blog index.
This filter is used in `source/_includes/article.html`
## Image Tag
This plugin makes it easy to insert images in a post, with optional class names, alt and title attributes.
[Examples & documentation &raquo;](/docs/plugins/image-tag/)
## Block quote ## Block quote
{% blockquote @AustinTaylor https://twitter.com/austintaylor/status/73136957617750016 %} {% blockquote @AustinTaylor https://twitter.com/austintaylor/status/73136957617750016 %}

View File

@ -14,19 +14,19 @@ the documentation and if you have trouble, [I'll be happy to help](http://convor
## Getting Started ## Getting Started
If you're using bundler and rvm, this should be a breeze. If you're using bundler and rvm, this should be a breeze.
- [Initial setup](/docs/setup) - Get source and install dependencies - [Initial setup](/docs/setup) - *get source and install dependencies*
- [Basic Configuration](/docs/configuring) - Enable third party services and personalize your blog - [Basic Configuration](/docs/configuring) - *enable third party services and personalize your blog*
- [Deploying Octopress](/docs/deploying) - Simple deploy instructions for Rsync and Github pages - [Deploying Octopress](/docs/deploying) - *simple deploy instructions for Rsync and Github pages*
## Using Octopress ## Using Octopress
Your blog should be awesome. This should help. Your blog should be awesome. This should help.
- [Blogging Basics](/docs/blogging) - How to create blog posts and pages - [Blogging Basics](/docs/blogging) - *how to create blog posts and pages*
- [Sharing Code Snippets](/docs/blogging/code) - Share code snippets with ease - [Sharing Code Snippets](/docs/blogging/code) - *share code snippets with ease*
- [Syntax Highlighting Test](/docs/blogging/code/test) - Language highlighting tests - [Syntax Highlighting Test](/docs/blogging/code/test) - *language highlighting tests*
- [Blogging With Plugins](/docs/blogging/plugins) - Overview of plugins for blogging - [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 [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 - TODO [Updating](/docs/updating) - *a guide to help you stay up to date*
## Octopress Plugins - Usage & Examples ## Octopress Plugins - Usage & Examples
{% render_partial docs/plugins/index.markdown %} {% render_partial docs/plugins/index.markdown %}

View File

@ -2,7 +2,17 @@
layout: page layout: page
title: "Category Generator" title: "Category Generator"
date: 2011-07-22 09:17 date: 2011-07-22 09:17
comments: true sidebar: false
sharing: true footer: false
footer: true
--- ---
The category generator builds category specific archive pages for each category in your blog posts.
The archive pages use the category layout (included with Octopress). In the `_config.yml` you may change
the directory for the category archives if you like and the title for the category pages.
category_dir: blog/categories
category_title_prefix: "Category: "
If you visit a category archive for 'open source' the url would be `/blog/categories/open-source/` and the title would be `Category: Open Source`.
This plugin was originally developed by [Dave Perrett](http://brandontilley.com/2011/01/31/gist-tag-for-jekyll.html) but it has been updated and improved for Octopress.

View File

@ -24,3 +24,4 @@ If you have a gist with multiple files, you can include files one at a time by a
{{ "{% gist 1059334 svg_bullets.rb" }} %} {{ "{% gist 1059334 svg_bullets.rb" }} %}
{{ "{% gist 1059334 usage.scss" }} %} {{ "{% gist 1059334 usage.scss" }} %}
This plugin was developed by [Brandon Tilly](http://brandontilley.com/2011/01/31/gist-tag-for-jekyll.html) but I have fixed some bugs and made some improvements to it for Octopress.

View File

@ -9,17 +9,21 @@ 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. 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.
- [Code Block](/docs/plugins/codeblock) - For easy inline code sharing - [Code Block](/docs/plugins/codeblock) - *for easy inline code sharing*
- [Include Code](/docs/plugins/include-code) - Embed code from your filesystem - [Include Code](/docs/plugins/include-code) - *embed code from your filesystem*
- [Gist Tag](/docs/plugins/gist-tag) - Automatically downloads and embeds Github gists - [Gist Tag](/docs/plugins/gist-tag) - *automatically downloads and embeds Github gists*
- [Render Partial](/docs/plugins/render-partial) - Insert any file into another post or page - [Render Partial](/docs/plugins/render-partial) - *insert any file into another post or page*
- [Image Tag](/docs/plugins/image-tag) - Easily post images with class names and titles - [Image Tag](/docs/plugins/image-tag) - *easily post images with class names and titles*
- [Blockquote](/docs/plugins/blockquote) - Generate beautiful, semantic block quotes - [Blockquote](/docs/plugins/blockquote) - *generate beautiful, semantic block quotes*
- [Pullquote](/docs/plugins/pullquote) - Generate CSS only pull quotes &mdash; no duplicate data, no javascript - [Pullquote](/docs/plugins/pullquote) - *generate CSS only pull quotes &mdash; no duplicate data, no javascript*
- [Custom filters](/docs/plugins/octopress-filters) - Liquid filters built just for Octopress - [Category Generator](/docs/plugins/category-generator) - *generates archive pages for each blog category*
- [Category Generator](/docs/plugins/category-generator) - Generates archive pages for each blog category
- Sitemap Generator - Generates an SEO friendly sitemap.xml The following filters are used by Octopress, and are documented as necessary in their source.
- Compass Compiler - Forces Jekyll to compile Compass on each load - Octopress filters - *liquid filters built just for Octopress*
- Haml Converter - Allows .haml pages to be processed by Jekyll - Sitemap Generator - *generates an SEO friendly sitemap.xml*
- Pygments Cache - Caches code snippets to speed up Jekyll processing - Compass Compiler - *forces Jekyll to compile Compass on each load*
- Titlecase - Required by several plugins to automatically generate proper title captalization - 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*
[Octopress plugins source](https://github.com/imathis/octopress/tree/master/plugins)

View File

@ -1,8 +0,0 @@
---
layout: page
title: "Filters"
date: 2011-07-22 09:17
comments: true
sharing: true
footer: true
---

View File

@ -2,9 +2,8 @@
layout: page layout: page
title: "Pullquote" title: "Pullquote"
date: 2011-07-22 09:15 date: 2011-07-22 09:15
comments: true sidebar: false
sharing: true footer: false
footer: true
--- ---
Octopress offers a CSS only technique for pull quotes, based on the technique by [Maykel Loomans](http://miekd.com/articles/pull-quotes-with-html5-and-css/). Octopress offers a CSS only technique for pull quotes, based on the technique by [Maykel Loomans](http://miekd.com/articles/pull-quotes-with-html5-and-css/).
@ -22,5 +21,5 @@ When writing longform posts, I find it helpful to include pull quotes to help re
It is important to note that {" pull quotes are merely visual in presentation and should not appear twice in the text. "} That is why it a CSS only technique for styling pull quotes is preferable. Octopress includes a handy pull quote plugin to make this easy for you. It is important to note that {" pull quotes are merely visual in presentation and should not appear twice in the text. "} That is why it a CSS only technique for styling pull quotes is preferable. Octopress includes a handy pull quote plugin to make this easy for you.
{% endpullquote %} {% endpullquote %}
Inspect the source and you'll see the pulled content appears in the data-pullquote attribute of the paragraph. The pull quote effect is created **Inspect the source** and you'll see the pulled content appears in the data-pullquote attribute of the paragraph. The pull quote effect is created
entirely with CSS, and is supported by all modern browsers as well as IE8 and up. entirely with CSS, and is supported by all modern browsers as well as IE8 and up.

View File

@ -6,7 +6,6 @@ sidebar: false
footer: false footer: false
--- ---
[Create a new repository](https://github.com/repositories/new) for your website then [Create a new repository](https://github.com/repositories/new) for your website then
open up a terminal and follow along. If you plan to host your site on [Github Pages](http://pages.github.com) for a user or organization, make sure the open up a terminal and follow along. If you plan to host your site on [Github Pages](http://pages.github.com) for a user or organization, make sure the
repository is named `your_username.github.com` or `your_organization.github.com`. repository is named `your_username.github.com` or `your_organization.github.com`.
@ -40,4 +39,7 @@ Install the default Octopress theme,
and you should be all set up to begin blogging with Octopress. and you should be all set up to begin blogging with Octopress.
**Note:** If you already have a blog, check out [Jekyll's Migration page](https://github.com/mojombo/jekyll/wiki/blog-migrations) to help you get your content formatted for Jekyll blogging.
[Next, Deploying Octopress &raquo;](/docs/deploying) [Next, Deploying Octopress &raquo;](/docs/deploying)