Merge branch 'site' of github.com:imathis/octopress into site

This commit is contained in:
Brandon Mathis 2011-12-10 08:42:03 -06:00
commit f369c73aee
4 changed files with 14 additions and 5 deletions

View File

@ -89,8 +89,7 @@ h3.filename {
p, li { p, li {
code { code {
@extend .mono; @extend .mono;
display: inline-block; white-space: pre;
white-space: no-wrap;
background: #fff; background: #fff;
font-size: .8em; font-size: .8em;
line-height: 1.5em; line-height: 1.5em;

View File

@ -7,7 +7,7 @@ comments: false
footer: false footer: false
--- ---
Octopress offers some rake tasks to create post and pages preloaded with metadata and according to Jekyll's naming conventions. Octopress offers some rake tasks to create post and pages preloaded with metadata and according to Jekyll's naming conventions. It also generates a global and a category based feed for your posts (You can find them in `atom.xml` and `blog/categories/<category>/atom.xml`).
## Blog Posts ## Blog Posts
Blog posts must be stored in the `source/_posts` directory and named according to Jekyll's naming conventions: `YYYY-MM-DD-post-title.markdown`. The name of the file will be used Blog posts must be stored in the `source/_posts` directory and named according to Jekyll's naming conventions: `YYYY-MM-DD-post-title.markdown`. The name of the file will be used
@ -94,13 +94,22 @@ Like with the new post task, the default file extension is `markdown` but you ca
The title is derived from the filename so you'll likely want to change that. This is very similar to the post yaml except it doesn't include categories, and you can toggle sharing and comments or remove the footer altogether. If you don't want to show a date on your page, just remove it from the yaml. The title is derived from the filename so you'll likely want to change that. This is very similar to the post yaml except it doesn't include categories, and you can toggle sharing and comments or remove the footer altogether. If you don't want to show a date on your page, just remove it from the yaml.
## Content
The page and post content will be rendered by whichever markup engine you have specified in the site configuration file. Additionally, you can use any of the [liquid template features](https://github.com/Shopify/liquid/wiki/Liquid-for-Designers) that are described in the [Jekyll docs](https://github.com/mojombo/jekyll/wiki/Template-Data).
Inserting a `<!-- more -->` comment into your post will prevent the post content below this mark from being displayed on the index page for the blog posts, a "Continue →" button links to the full post.
## Generate & Preview ## Generate & Preview
``` sh ``` sh
rake generate # Generates posts and pages into the public directory rake generate # Generates posts and pages into the public directory
rake watch # Watches source/ and sass/ for changes and regenerates rake watch # Watches source/ and sass/ for changes and regenerates
rake preview # Watches, and mounts a webserver at http://localhost:4000 rake preview # Watches, and mounts a webserver at http://localhost:4000
``` ```
If you want to work on posts without publishing them, you can add a `published: false` to your post's YAML header. You can preview these posts with `rake preview` on your local server, but they won't get published by `rake generate`.
Using the `rake preview` server is nice, but If you're a [POW](http://pow.cx) user, you can set up your Octopress site like this. Using the `rake preview` server is nice, but If you're a [POW](http://pow.cx) user, you can set up your Octopress site like this.
``` sh ``` sh

View File

@ -9,7 +9,7 @@ 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.
- [HTML5 Video Tag](/docs/plugins/video-tag/) - *easily post images with class names and titles* - [HTML5 Video Tag](/docs/plugins/video-tag/) - *embeds mp4 encoded HTML5 videos*
- [Backtick Code Block](/docs/plugins/backtick-codeblock/) - *for simple lightweight code sharing* - [Backtick Code Block](/docs/plugins/backtick-codeblock/) - *for simple lightweight code sharing*
- [Code Block](/docs/plugins/codeblock/) - *for sharing code with titles and links* - [Code Block](/docs/plugins/codeblock/) - *for sharing code with titles and links*
- [Include Code](/docs/plugins/include-code/) - *embed code from your filesystem with a download link* - [Include Code](/docs/plugins/include-code/) - *embed code from your filesystem with a download link*

View File

@ -14,7 +14,7 @@ If that sounds daunting, Octopress probably isn't for you.
You'll need to [install Git](http://git-scm.com/) and set up your Ruby environment. You'll need to [install Git](http://git-scm.com/) and set up your Ruby environment.
**Octopress requires Ruby 1.9.2** wich you can easily install with [RVM](http://rvm.beginrescueend.com) or [rbenv](https://github.com/sstephenson/rbenv). **Octopress requires Ruby 1.9.2** wich you can easily install with [RVM](http://rvm.beginrescueend.com) or [rbenv](https://github.com/sstephenson/rbenv).
You can't use both rbenv and RVM on the same system, so choose one. You can't use both rbenv and RVM on the same system, as they are competing Ruby environment managers, so choose one.
### Using RVM ### Using RVM
@ -46,6 +46,7 @@ Next, install dependencies.
```sh ```sh
gem install bundler gem install bundler
rbenv rehash # If you use rbenv, rehash to be able to run the bundle command
bundle install bundle install
``` ```