octopress 3.0.0.alpha8 → 3.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f9b1847085d24d5bdfcfc8c587c68d416bd9d95
-  data.tar.gz: f4dde30b1c537623df72a4d3bca0f99f308292e0
+  metadata.gz: 787005c08bc0ed8ae3f2eefcf5b38ea90b372b20
+  data.tar.gz: 8824a64b418e2eb02a19bdef317ce9040a406628
 SHA512:
-  metadata.gz: 439892300f2b23d9c19547ab05dbd409388db470f78069d2ae53339fea3079f1b0db1f3086a66adc304e4ed86dc45554d6f74b5987c58d5ac4966ec6c07a78e3
-  data.tar.gz: 67f5ca769098c7f138dc24791a8b36c50dc837591095e772bb9fb4570997c03a797649b2f119be9a384b83eb599ba33bcb324b2d7f3ad7600058af418d53e49c
+  metadata.gz: ccec315c07272d23b79a08a48309e92aa8781f7dbca95f15c7985ded4c3e6794e08ff2eab110d32978856442d817c6ea235de5f1bb1d67874f390540668f0724
+  data.tar.gz: 9fb4b0328393f5880217ff015ae256149afdf0a9f8d666929d43fbb86abde7940b1603ab26b59f5930c0fb6f1cf518ccc307713a9929d022508df051d83c4cfe

data/.gitignore

@@ -15,4 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-_site
+.sass-cache
+.code-highlighter-cache
+test-site

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+script: cd test && bundle exec ruby test.rb

data/README.md

@@ -17,53 +17,156 @@ Or install it yourself as:
 
     $ gem install octopress
 
-## Usage
+## Basic Usage
 
-### Generating a new site
+Here are the commands for Octopress.
 
-To create a new scaffold of directories and files in a new directory named my_blog:
+| 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`          |
 
-```bash
-$ octopress new my_blog
+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
 ```
 
-### Generating a new Post
+## 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 --title "My Title"
+$ 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       | Type     | Description |
-|:-------------|:---------|:------------|
-| `title`      | `String` | The title of the new post |
-| `date`       | `String` | 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) (defaults to Time.now) |
-| `slug`       | `String` | The slug for the new post. |
-| `categories` | `Array`  | A comma-separated list of categories to which this post belongs |
-| `tags`       | `Array`  | A comma-separated list of tags for this post |
+| 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.                  |
+| `--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
+```
 
-### Generating a new Page
+| 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 page --path about/index.markdown
+$ octopress new draft "My Title"
 ```
 
-| Option       | Type     | Description |
-|:-------------|:---------|:------------|
-| `title`      | `String` | The title of the new page |
-| `date`       | `String` | 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) |
-| `path`       | `String` | The path at which the new page should be generated. |
+This will create a new post in your `_drafts` directory.
 
-### Other Commands
+| 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.                  |
 
-Octopress also has the following commands, bundled as separate gems:
+### Publish draft
 
-| Command  | Gem                  | Description |
-|:---------|:---------------------|:------------|
-| `deploy` | [octopress-deploy][] | Deployment for Octopress and Jekyll blogs. |
+```bash
+$ octopress publish _drafts/some-post.md
+```
 
-[octopress-deploy]: https://github.com/octopress/deploy
+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.         |
+| `--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
 

data/lib/octopress.rb

@@ -1,20 +1,22 @@
 require 'mercenary'
 
 module Octopress
-  require 'octopress/core_ext'
+  require 'octopress/ext/hash'
+  require 'octopress/ext/titlecase'
   require 'octopress/configuration'
   require 'octopress/command'
   require 'octopress/version'
   require 'octopress/commands/new'
+  require 'octopress/commands/init'
   require 'octopress/commands/publish'
   require 'octopress/commands/build'
   require 'octopress/commands/serve'
   require 'octopress/commands/doctor'
-  require 'octopress/commands/docs'
 
   autoload :Page, 'octopress/page'
   autoload :Post, 'octopress/post'
   autoload :Draft, 'octopress/draft'
+  autoload :Scaffold, 'octopress/scaffold'
 
   BLESSED_GEMS = %w[
     octopress-deploy
@@ -31,6 +33,10 @@ module Octopress
     @config ||= Configuration.config(options)
   end
 
+  def self.expand_gem_path(dir='')
+    File.expand_path(File.join(File.dirname(__FILE__), '../', dir))
+  end
+
   def self.require_blessed_gems
     BLESSED_GEMS.each do |gem|
       begin

data/lib/octopress/command.rb

@@ -1,3 +1,6 @@
+require 'jekyll'
+require File.expand_path('commands/helpers', File.dirname(__FILE__))
+
 module Octopress
   class Command
     def self.inherited(base)

data/lib/octopress/commands/build.rb

@@ -1,11 +1,8 @@
-require 'jekyll'
-require File.expand_path('helpers', File.dirname(__FILE__))
-
 module Octopress
   class Build < Command
     def self.init_with_program(p)
       p.command(:build) do |c|
-        c.syntax 'octopress build [options]'
+        c.syntax 'build [options]'
         c.description 'Build your site'
         CommandHelpers.add_build_options(c)
         

data/lib/octopress/commands/doctor.rb

@@ -1,21 +1,17 @@
-require 'jekyll'
-require File.expand_path('helpers', File.dirname(__FILE__))
-
 module Octopress
   class Doctor < Command
     def self.init_with_program(p)
       p.command(:doctor) do |c|
         c.alias(:hyde)
 
-        c.syntax 'octopress doctor'
+        c.syntax 'doctor'
         c.description 'Search site and print specific deprecation warnings'
-
-        c.option 'config', '--config CONFIG_FILE[,CONFIG_FILE2,...]', Array, 'Custom configuration file'
+        CommandHelpers.add_common_options c
 
         c.action do |args, options|
           options = CommandHelpers.normalize_options(options)
           options = Jekyll.configuration(options.to_symbol_keys)
-          ::Jekyll::Commands::Doctor.process(options)
+          Jekyll::Commands::Doctor.process(options)
         end
       end
     end

data/lib/octopress/commands/helpers.rb

@@ -18,10 +18,15 @@ module Octopress
       options
     end
 
+    def self.add_page_options(c)
+      c.option 'template', '--template PATH', "New #{c.name.to_s} from a template."
+      c.option 'date', '--date DATE', "Use 'now' or a String that is parseable by Time#parse. (default: Time.now.iso8601)"
+      c.option 'force', '--force', 'Overwrite file if it already exists'
+    end
+
     def self.add_common_options(c)
-      c.option 'template', '--template PATH', "New #{c.name.to_s} from a template. PATH is relative to _templates/"
-      c.option 'date', '--date DATE', 'String that is parseable by Time#parse. (default: Time.now.iso8601)'
-      c.option 'force', '--force', 'Force creation even if PATH already exists'
+      c.option 'config', '--config <CONFIG_FILE>[,CONFIG_FILE2,...]', Array, 'Custom Jekyll configuration file'
+      c.option 'octopress-config', '--octopress-config <CONFIG_FILE>', 'Custom Octopress configuration file'
     end
   end
 end

data/lib/octopress/commands/init.rb

@@ -0,0 +1,15 @@
+module Octopress
+  class Init < Command
+    def self.init_with_program(p)
+      p.command(:init) do |c|
+        c.syntax 'init <PATH> [options]'
+        c.description "Add Octopress's default scaffolding to your site."
+        c.option 'force', '--force', 'Overwrite files if they already exist.'
+
+        c.action do |args, options|
+          Scaffold.new(args, options).write
+        end
+      end
+    end
+  end
+end

data/lib/octopress/commands/new.rb

@@ -1,51 +1,54 @@
-require 'jekyll'
-
 module Octopress
   class New < Command
     def self.init_with_program(p)
       p.command(:new) do |c|
         c.syntax 'new <PATH>'
-        c.description 'Creates a new Jekyll site scaffold in path'
-        c.option 'force', '--force', 'Force creation even if path already exists'
-        c.option 'blank', '--blank', 'Creates scaffolding but with empty files'
+        c.description 'Creates a new Jekyll site scaffold in path.'
+        c.option 'force', '--force', 'Force creation even if path already exists.'
+        c.option 'blank', '--blank', 'Creates scaffolding but with empty files.'
         
         c.action do |args, options|
           if args.empty?
             c.logger.error "You must specify a path."
           else
-            ::Jekyll::Commands::New.process(args, options.to_symbol_keys)
+            Jekyll::Commands::New.process(args, options.to_symbol_keys)
           end
         end
 
-        c.command(:page) do |page_command|
-          page_command.syntax 'page <PATH> [options]'
-          page_command.description 'Add a new page to your Jekyll site.'
-          page_command.option 'title', '--title TITLE', 'String to be added as the title in the YAML front-matter.'
-          CommandHelpers.add_common_options page_command
+        c.command(:page) do |c|
+          c.syntax 'page <PATH> [options]'
+          c.description 'Add a new page to your Jekyll site.'
+          c.option 'title', '--title TITLE', 'String to be added as the title in the YAML front-matter.'
+          CommandHelpers.add_page_options c
+          CommandHelpers.add_common_options c
 
-          page_command.action do |args, options|
+          c.action do |args, options|
             options['path'] = args.first
             Page.new(options).write
           end
         end
 
-        c.command(:post) do |post_command|
-          post_command.syntax 'post <TITLE> [options]'
-          post_command.description 'Add a new post to your Jekyll site.'
-          CommandHelpers.add_common_options post_command
+        c.command(:post) do |c|
+          c.syntax 'post <TITLE> [options]'
+          c.description 'Add a new post to your Jekyll site.'
+          CommandHelpers.add_page_options c
+          c.option 'slug', '--slug SLUG', 'Use this slug in filename instead of sluggified post title.'
+          CommandHelpers.add_common_options c
 
-          post_command.action do |args, options|
+          c.action do |args, options|
             options['title'] = args.first
             Post.new(options).write
           end
         end
 
-        c.command(:draft) do |draft_command|
-          draft_command.syntax 'draft <TITLE> [options]'
-          draft_command.description 'Add a new draft post to your Jekyll site.'
-          CommandHelpers.add_common_options draft_command
+        c.command(:draft) do |c|
+          c.syntax 'draft <TITLE> [options]'
+          c.description 'Add a new draft post to your Jekyll site.'
+          CommandHelpers.add_page_options c
+          c.option 'slug', '--slug SLUG', 'Use this slug in filename instead of sluggified post title.'
+          CommandHelpers.add_common_options c
 
-          draft_command.action do |args, options|
+          c.action do |args, options|
             options['title'] = args.first
             Draft.new(options).write
           end

data/lib/octopress/commands/publish.rb

@@ -2,9 +2,11 @@ module Octopress
   class Publish < Command
     def self.init_with_program(p)
       p.command(:publish) do |c|
-        c.syntax 'octopress publish PATH [options]'
+        c.syntax 'publish <PATH> [options]'
         c.description 'Convert a draft to a normal published post.'
         c.option 'date', '--date DATE', 'String that is parseable by Time#parse. (default: Time.now.iso8601)'
+        c.option 'force', '--force', 'Overwrite file if it already exists'
+        CommandHelpers.add_common_options c
 
         c.action do |args, options|
           abort "You must specify a path." if args.empty?

data/lib/octopress/commands/serve.rb

@@ -1,13 +1,10 @@
-require 'jekyll'
-require File.expand_path('helpers', File.dirname(__FILE__))
-
 module Octopress
   class Serve < Command
     def self.init_with_program(p)
       p.command(:serve) do |c|
         c.alias(:server)
 
-        c.syntax 'jekyll serve [options]'
+        c.syntax 'serve [options]'
         c.description 'Serve your site locally'
 
         CommandHelpers.add_build_options(c)
@@ -22,9 +19,9 @@ module Octopress
 
           options.default :serving => true
           options = CommandHelpers.normalize_options(options)
-          options = ::Jekyll.configuration(options.to_symbol_keys)
-          ::Jekyll::Commands::Build.process(options)
-          ::Jekyll::Commands::Serve.process(options)
+          options = Jekyll.configuration(options.to_symbol_keys)
+          Jekyll::Commands::Build.process(options)
+          Jekyll::Commands::Serve.process(options)
         end
       end
     end