octopress 3.0.0.rc.5 → 3.0.0.rc.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fe4fdff1a4578d127d4e66f27b26b9b4a0506fd
-  data.tar.gz: 2ca77bee7eea06456f1f7e126daf79d03b3dd616
+  metadata.gz: 5fede7ae0afd1befce5f8987619090363089f210
+  data.tar.gz: c8558827ffd7810eb1cb0b9f032d5d0f054cea09
 SHA512:
-  metadata.gz: 05c9fa85c1e723e305bcb613d48895091f83097bb903d479b9e657554969cd1db9da514238d43eca0a428ddcc6638918b16ca526204bb6b4c6d1468527f839c1
-  data.tar.gz: a31c675aad0c3f91bab33d700ddb61b3a425d39b9f15020bda6ea64c2bf3082360c01229533fc3ffe7e670c113fa2ca3320840abaf4da6c76e5380b100fdb4ea
+  metadata.gz: 3345a39fa96775e47225ae13964e72c9252586a56fe9aa1066519096bc326ea3db34eee47aae131c506939c11f1dac6a2a82754b96f8c710298c104aa75587ed
+  data.tar.gz: efdcb8c284cfc4128a31e92081023261c7771f96304a62ef2c9cd897cb1ded096becd2cbb0bf4a4a25896419baca8347b7f8812995d25f46aca758649776524d

data/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Octopress Changelog
+
+## Current released version
+
+### 3.0.0 RC6 - 2014-03-22
+
+- Added support for octopress-ink documentation system.
+- Added a `update_docs` Rake task to update docs from the readme and changelog.
+
+## Past versions
+
+### 3.0.0 RC5 - 2014-03-21
+- Added octopress-docs to blessed gem list.
+
+### 3.0.0 RC4 - 2014-03-18
+- Updated mercenary. Fixed issue: #34
+
+### 3.0.0 RC3 - 2014-03-18
+- `serve --watch` fixed. Fixed issue: #33
+
+### 3.0.0 RC2 - 2014-03-18
+- `new post` command has new `--dir` option to save new posts in _posts/<DIR>/. Fixed issue #31
+
+### 3.0.0 RC1 - 2014-03-17
+- Initial release of Octopress CLI
+

data/README.md

@@ -1,7 +1,6 @@
 # Octopress
 
-Octopress is an obsessively designed toolkit for writing and deploying Jekyll
-blogs. Pretty sweet, huh?
+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)
@@ -10,7 +9,7 @@ blogs. Pretty sweet, huh?
 
 Add this line to your application's Gemfile:
 
-    gem 'octopress', '~> 3.0.0.rc.4'
+    gem 'octopress', '~> 3.0.0.rc.5'
 
 And then execute:
 

data/Rakefile

@@ -1 +1,8 @@
 require "bundler/gem_tasks"
+require "octopress-ink"
+
+desc "Copy Readme and Changelog into docs"
+task :update_docs do
+  Octopress::Ink.copy_doc 'README.md', 'assets/docs/index.markdown'
+  Octopress::Ink.copy_doc 'CHANGELOG.md', 'assets/docs/changelog/index.markdown'
+end

data/assets/docs/changelog/index.markdown

@@ -0,0 +1,29 @@
+---
+title: "Octopress Changelog"
+---
+
+### HEAD - 3.0.0 RC6
+
+#### Minor Enhancements
+- Added support for octopress-ink documentation system.
+- Added a `update_docs` Rake task to update index/docs/index.markdown from README.md.
+
+## Current released version
+
+### 3.0.0 RC5 - 2014-03-21
+- Added octopress-docs to blessed gem list.
+
+## Past versions
+
+### 3.0.0 RC4 - 2014-03-18
+- Updated mercenary. Fixed issue: #34
+
+### 3.0.0 RC3 - 2014-03-18
+- `serve --watch` fixed. Fixed issue: #33
+
+### 3.0.0 RC2 - 2014-03-18
+- `new post` command has new `--dir` option to save new posts in _posts/<DIR>/. Fixed issue #31
+
+### 3.0.0 RC1 - 2014-03-17
+- Initial release of Octopress CLI
+

data/assets/docs/index.markdown

@@ -0,0 +1,183 @@
+---
+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)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress', '~> 3.0.0.rc.5'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress --pre
+
+## Basic Usage
+
+Here are the commands for Octopress.
+
+| Option                          | Description                               |
+|:--------------------------------|:------------------------------------------|
+| `octopress init <PATH>`         |  Adds Octopress scaffolding to your site  |
+| `octopress new post <TITLE>`    |  Add a new post to your site              |
+| `octopress new page <PATH>`     |  Add a new page to your site              |
+| `octopress new draft <TITLE>`   |  Add a new draft post to your site        |
+| `octopress publish <PATH>`      |  Publish a draft from _drafts to _posts   |
+| `octopress new <PATH>`          |  works just like `jekyll new`             |
+| `octopress build`               |  works just like `jekyll build`           |
+| `octopress serve`               |  works just like `jekyll serve`           |
+| `octopress doctor`              |  works just like `jekyll doctor`          |
+
+Run `octopress [command] --help` to learn more about any command and see its options.
+
+### Deployment
+
+You can deploy your Octopress or Jeklly blog via git, rsync or Amazon S3. The deployment system ships with the [octopress-deploy][] gem which extends the Octopress CLI with the `deploy` command.
+
+[octopress-deploy]: https://github.com/octopress/deploy
+
+## Configuration
+
+Octopress reads its configurations from `_octopress.yml`. Here's what the configuration looks like by default.
+
+```yaml
+# Default extension for new posts and pages
+post_ext: markdown
+page_ext: html
+
+# Default templates for posts and pages
+# Found in _templates/
+post_layout: post
+page_layout: page
+
+# Format titles with titlecase?
+titlecase: true
+```
+
+## Commands
+
+### Init
+
+
+```sh
+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:
+
+```
+_octopress.yml
+_templates/
+  post
+  page
+```
+
+### New Post
+
+This automates the creation of a new post.
+
+```bash
+$ 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.
+
+```
+layout: post
+title: "My Title"
+date: YYYY-MM-DDTHH:MM:SS-00:00
+```
+
+"Ok, great? What else can I do?" Great question! Check out these other options:
+
+| Option               | Description                             |
+|:---------------------|:----------------------------------------|
+| `--template PATH`    | Use a template from <path>              |
+| `--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`        | Slug for the new post.                  |
+| `--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
+```
+
+| Option               | Description                             |
+|:---------------------|:----------------------------------------|
+| `--template PATH`    | Use a template from <path>              |
+| `--title TITLE`      | The title of the new page               |
+| `--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
+$ octopress new draft "My Title"
+```
+
+This will create a new post in your `_drafts` directory.
+
+| Option             | Description                               |
+|:-------------------|:------------------------------------------|
+| `--template PATH`    | Use a template from <path>              |
+| `--date DATE`      | The date for the draft. Should be parseable by [Time#parse](http://ruby-doc.org/stdlib-2.1.0/libdoc/time/rdoc/Time.html#method-i-parse) (defaults to Time.now) |
+| `--slug SLUG`      | The slug for the new post.                |
+| `--force`          | Overwrite exsiting file.                  |
+
+### Publish draft
+
+```bash
+$ octopress publish _drafts/some-post.md
+```
+
+This will move your draft to the `_posts` directory and rename the file with the proper date.
+
+| Option             | Description                               |
+|:-------------------|:------------------------------------------|
+| `--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 }}
+---
+
+```
+
+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
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/bin/octopress

@@ -7,6 +7,11 @@ require 'octopress'
 
 Octopress.require_blessed_gems
 
+if defined? Octopress::Ink
+  require 'octopress/docs'
+  Octopress::Ink.register_plugin(Octopress::CLIDocs)
+end
+
 if ENV['BUNDLE_BIN_PATH'] || ENV['BUNDLE_GEMFILE']
   begin
     require 'bundler'

data/lib/octopress.rb

@@ -34,7 +34,7 @@ module Octopress
     @config ||= Configuration.config(options)
   end
 
-  def self.expand_gem_path(dir='')
+  def self.gem_dir(dir='')
     File.expand_path(File.join(File.dirname(__FILE__), '../', dir))
   end
 
@@ -47,4 +47,3 @@ module Octopress
     end
   end
 end
-

data/lib/octopress/docs.rb

@@ -0,0 +1,25 @@
+module Octopress
+  class CLIDocs < Octopress::Ink::Plugin
+    def configuration
+      {
+        name:        "Octopress",
+        description: "An obsessively designed framework for Jekyll sites.",
+        slug:        "cli",
+        assets_path: Octopress.gem_dir('assets'),
+        version:     Octopress::VERSION
+      }
+    end
+
+    def docs_base_path
+      'docs/cli'
+    end
+
+    def info(options)
+      if options['docs']
+        super
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/octopress/scaffold.rb

@@ -19,7 +19,7 @@ module Octopress
     end
 
     def scaffold_path
-      Octopress.expand_gem_path('scaffold')
+      Octopress.gem_dir('scaffold')
     end
     
   end

data/lib/octopress/version.rb

@@ -1,3 +1,3 @@
 module Octopress
-  VERSION = "3.0.0.rc.5"
+  VERSION = "3.0.0.rc.6"
 end

data/octopress.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "mercenary", "~> 0.3.2"
   spec.add_runtime_dependency "jekyll", "~> 1.4.3"
 
+  spec.add_development_dependency "octopress-ink"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "pry-debugger"
   spec.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopress
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc.5
+  version: 3.0.0.rc.6
 platform: ruby
 authors:
 - Brandon Mathis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-22 00:00:00.000000000 Z
+date: 2014-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -39,6 +39,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.4.3
+- !ruby/object:Gem::Dependency
+  name: octopress-ink
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -93,10 +107,13 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- assets/docs/changelog/index.markdown
+- assets/docs/index.markdown
 - bin/octopress
 - lib/octopress.rb
 - lib/octopress/command.rb
@@ -108,6 +125,7 @@ files:
 - lib/octopress/commands/publish.rb
 - lib/octopress/commands/serve.rb
 - lib/octopress/configuration.rb
+- lib/octopress/docs.rb
 - lib/octopress/draft.rb
 - lib/octopress/ext/hash.rb
 - lib/octopress/ext/titlecase.rb