assets/docs/index.markdown in octopress-3.0.0.rc.6 vs assets/docs/index.markdown in octopress-3.0.0.rc.7
- old
+ new
@@ -1,9 +1,10 @@
---
title: "Octopress"
---
+
Octopress is an obsessively designed toolkit for writing and deploying Jekyll blogs. Pretty sweet, huh?
<!--[![Gem Version](https://badge.fury.io/rb/octopress.png)](http://badge.fury.io/rb/octopress)-->
[![Build Status](https://travis-ci.org/octopress/octopress.png?branch=master)](https://travis-ci.org/octopress/octopress)
@@ -67,11 +68,11 @@
### Init
```sh
-octopress init <PATH> [options]
+$ octopress init <PATH> [options]
```
This will copy Octopress's scaffolding into the specified directory. Use the `--force` option to overwrite existing files. The scaffolding is pretty simple:
```
@@ -83,11 +84,11 @@
### New Post
This automates the creation of a new post.
-```bash
+```sh
$ octopress new post "My Title"
```
This will create a new file at `_posts/YYYY-MM-DD-my-title.markdown` with the following YAML front-matter already added.
@@ -107,11 +108,11 @@
| `--dir DIR` | Create post at _posts/DIR/. |
| `--force` | Overwrite exsiting file. |
### New Page
-```sh
+```
$ octopress new page some-page # ./some-page.html
$ octopress new page docs/ # ./docs/index.html
$ octopress new page about.html # ./about.html
```
@@ -122,11 +123,11 @@
| `--date DATE` | The date for the page. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
| `--force` | Overwrite exsiting file. |
### New Draft
-```bash
+```sh
$ octopress new draft "My Title"
```
This will create a new post in your `_drafts` directory.
@@ -137,11 +138,11 @@
| `--slug SLUG` | The slug for the new post. |
| `--force` | Overwrite exsiting file. |
### Publish draft
-```bash
+```sh
$ octopress publish _drafts/some-post.md
```
This will move your draft to the `_posts` directory and rename the file with the proper date.
@@ -149,19 +150,18 @@
|:-------------------|:------------------------------------------|
| `--date DATE` | The date for the post. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) |
| `--slug SLUG` | Change the slug for the new post. |
| `--dir DIR` | Create post at _posts/DIR/. |
| `--force` | Overwrite exsiting file. |
-```
When publishing a draft, the new post will use the draft's date. Pass the option `--date now` to the publish command to set the new post date from your system clock. As usual, you can pass any compatible date string as well.
### Templates for Posts and pages
Octopress post and page templates look like this.
-```html
+```
---
layout: {{ layout }}
title: {{ title }}
date: {{ date }}
---
@@ -169,10 +169,10 @@
```
The YAML variables will be replaced with the correct content when you create a page or post. To modify this template create a `_templates/post` file and change it as you wish. You can add additional YAML front-matter or content, and you can even create multiple templates. Choose a custom template when creating a new post or page like this.
```sh
-octopress new post --template _templates/linkpost
+$ octopress new post --template _templates/linkpost
```
## Contributing
1. Fork it