octopress-ink 1.0.0.alpha.42 → 1.0.0.alpha.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ea8a006600a51e0bfc3c4816f20da55e849d52a
-  data.tar.gz: 5a4e760a5f58d4225bced80fd31d57f80c904683
+  metadata.gz: db0b53411b0e6748e5281e9db9fa6ef247296b9e
+  data.tar.gz: 8ff58d71d3cd6c9b75ba143e072fca4ce169b906
 SHA512:
-  metadata.gz: 188cec7106b750e62cd193bb5c54fea9965c3733b5854ab02a30562ea00ae3cb1867eccaf78ba9814f4f8156ef4e7d1c273adbb21b130cefa3152a77c1b9aadc
-  data.tar.gz: 84967eb34ce31062e3699c6f9a4009cbbc8146db0da74d9be6d1372773a0fe7b371017eddbe7b0f19e4b060e10358c764da078b1ddf11d4552f75496719d431e
+  metadata.gz: 1c455972095fe4418cfaf5ec2e70c3a6cb1785cf8d0cd29989d433425240532aa3f62b92098c02d9316844bfbe62ee963ae05758fd74d21cfa799303d169eb56
+  data.tar.gz: f9e610a3b80b20731db06b95f43931988167fd2b9b58190703f6d029bc58bb600250085f96497e0e1459f65af08d7d38f313ef6829a106a4659ef21e58d3c8eb

data/assets/docs/_configuration.markdown

@@ -0,0 +1,9 @@
+| Configuration | Description |
+|:--------------|:------------|
+| name          | The display name for your plugin, e.g. "My Plugin" |
+| assets_path   | Path to your plugin's assets directory | 
+| slug          | Optional: The slug is how users will reference your plugin, (Default: sluggified name) |
+| type          | Optional: "plugin" or "theme" (Default: "plugin") |
+| version       | Optional: Version will be displayed with plugin info |
+| description   | Optional: Description will be displayed with plugin info |
+| website       | Optional: Website will be displayed with plugin info |

data/assets/docs/_plugin-template.markdown

@@ -0,0 +1,25 @@
+```ruby
+require "octopress-ink"
+
+module MyPlugin
+  class InkPlugin < Octopress::Ink::Plugin
+    
+    # Define the configuration for your plugin
+    #
+    def configuration
+      {
+        name:          "My plugin",
+        slug:          "my-plugin",
+        assets_path:   File.expand_path(File.join(File.dirname(__FILE__), '../assets')),
+        type:          "plugin",
+        version:       MyPlugin::VERSION,
+        description:   "",
+        website:       ""
+      }
+    end
+  end
+end
+
+# Register the plugin with Octopress Ink
+Octopress::Ink.register_plugin(SomePlugin::InkPlugin)
+```

data/assets/docs/creating-a-gem.markdown

@@ -0,0 +1,69 @@
+---
+title: "Creating a Gem"
+permalink: /guides/creating-a-gem/
+---
+
+*This guide assumes you have already installed Git, and Ruby 1.9.3 or greater.*
+
+Octopress Ink plugins are distributed as ruby gems so you'll probably need to create an acconut at [RubyGems.org](https://rubygems.org/sign_up) if you haven't yet. Also, be sure you have [bundler](http://bundler.io) installed.
+
+### How to Create a Gem
+
+The [bundler gem](http://bundler.io/) is a great way to manage gems and provides some terrific utilites for gem creators. Go ahead and
+install it if you haven't yet.
+
+```sh
+gem install bundler
+```
+
+Now we'll use Bundler to create a gem project for our new plugin.
+
+```sh
+bundle gem baconnaise
+```
+
+That's right, this plugin will be called `baconnaise`. That command will generate a bunch of files into the new `baconnaise` directory. Take a peek inside and you'll see somethig like this:
+
+```
+lib/
+  baconnaise/
+    version.rb
+  baconnaise.rb
+baconnaise.gemspec
+Gemfile
+LICENSE.txt
+Rakefile
+README.md
+```
+
+First, you'll want to edit your `baconnaise.gemspec` to be sure the information in that is right. Be sure to change the default description and summary. The gem won't build if you have a *TODO* in either of those. Here's what we're gonig to go with.
+
+```ruby
+spec.description   = %q{Baconnaise, because mistakes have never been this spreadable.}
+spec.summary       = %q{Baconnaise, because #YOLO.}
+```
+
+Next you'll want to add Octopress Ink as a runtime dependency. Here's what that looks like.
+
+```ruby
+spec.add_runtime_dependency 'octopress-ink', '~> 1.0'
+```
+
+#### A note on Version Numbering
+
+By default the `bundle gem` command starts you off at version `0.0.1`. If you take a look at `lib/baconnaise/version.rb` you'll see this.
+
+```
+module Baconnaise
+  VERSION = "0.0.1"
+end
+```
+
+I'd encourage you to change your version number to `1.0.0` as soon as you release your plugin for production use. For a sensible guide on version numbers, refer to [semver.org](http://semver.org/).
+
+---
+
+For the next part we'll take a look at creating an Octopress Ink plugin.
+
+[Creating a Plugin →]({% doc_url /guides/creating-a-plugin/ %})
+

data/assets/docs/creating-a-plugin.markdown

@@ -0,0 +1,57 @@
+---
+title: "Create an Octopress Ink Plugin"
+permalink: /guides/creating-a-plugin/
+---
+
+If you haven't created a ruby gem for your plugin, check out [Creating a Gem]({% doc_url /guides/creating-a-gem/ %}).
+
+In this section we'll create an Octopress Ink plugin. Take a look at `lib/baconnaise.rb`. You should see
+something like this:
+
+```ruby
+require "baconnaise/version"
+
+module Baconnaise
+  # Your code goes here...
+end
+```
+
+We'll require octopress-ink add a configuration method, and register the plugin with Octopress Ink plugin. Here's what `lib/baconnaise.rb` after we've done that.
+
+```ruby
+require "baconnaise/version"
+require "octopress-ink"
+
+module Baconnaise
+  class InkPlugin < Octopress::Ink::Plugin
+    def configuration
+      {
+        # your configuration goes here.
+      }
+    end
+  end
+end
+
+# Register the plugin with Octopress Ink
+Octopress::Ink.register_plugin(Baconnaise::InkPlugin)
+```
+
+Now when Jekyll requires your plugin, it will register with Octopress Ink. The configuration options are as follows:
+
+{% render ./_configuration.markdown %}
+
+For Baconnaise, our configuration medthod will look like this:
+
+```ruby
+def configuration
+  {
+    name:        "Baconnaise",
+    slug:        "baconnaise",
+    assets_path: File.expand_path(File.join(File.dirname(__FILE__), '../assets')),
+    type:        "plugin",
+    version:     Baconnaise::VERSION,
+    description: "Baconnaise, because mistakes have never been this spreadable.",
+    website:     "http://baconnaise-craze.info/or/something/"
+  }
+end
+```

data/assets/docs/index.markdown

@@ -0,0 +1,63 @@
+---
+title: Octopress Ink
+---
+
+Octopress Ink helps developers create plugins and themes which integrate seamlessly into any Jekyll site. 
+
+#### Benefits For users
+
+- Go from vanilla Jekyll to a fully featured site in minutes.
+- Plugins are easy to install and uninstall.
+- Customization is simple and consistent.
+- Easily view documentation for your unique setup, even offline.
+
+[Using Octopress Ink plugins →]({% doc_url for-users %})
+
+#### Benefits For Developers
+
+- Automatically integrate with the asset pipeline.
+- Easily convert plugins you've already written.
+- Plugins automatically integrate with the Octopress CLI.
+
+[Developing with Octopress Ink →]({% doc_url for-developers %})
+
+#### Shipping assets
+- Asset pipeline
+- Automatic namespacing
+- Easy customization
+- Versioned release
+- Dependencies (build on others)
+
+#### Shipping themes
+- Layouts
+- Includes
+- Pages
+- Files
+- Easy override
+- Installable
+
+#### Customization
+
+assets/
+  docs/
+    index.markdown
+  stylesheets/
+    plugin.scss
+  javascripts/
+    plugin.js
+
+lib/
+  furbysaurus/
+    version.rb
+  furbysaurus.rb
+
+CHANGELOG.md
+Gemfile
+LICENSE.txt
+furbysaurus.gemspec
+Rakefile
+README.md
+```
+
+## Creating a theme
+

data/assets/docs/plugin-reference.markdown

@@ -0,0 +1,22 @@
+---
+title: "Octopress Ink Plugin Reference"
+permalink: /plugin-reference/
+---
+
+Octopress Ink plugins should be distributed as ruby gems. If you don't know how to create a ruby gem, [follow this walkthrough]({% doc_url /guides/create-a-gem/ %}).
+
+### Plugin Template
+
+This is the basic template for creating an Octopress Ink plugin.
+
+{% render ./_plugin-template.markdown %}
+
+### Configuration Reference
+
+The configuration options are as follows:
+
+{% render ./_configuration.markdown %}
+
+### Plugin Assets
+
+You can set `assets_path` to point wherever you like insde your gem file, but in this case we have it pointing to the `assets` directiory in root of the gem. There isn't a directory there yet, so we'll need to add one, and while were at it, add any assets that this plugin will need.

data/lib/octopress-ink.rb

@@ -135,23 +135,22 @@ module Octopress
     end
 
     def self.gem_dir(*subdirs)
-      File.expand_path(File.join(File.dirname(__FILE__), '../..', *subdirs))
+      File.expand_path(File.join(File.dirname(__FILE__), '../', *subdirs))
     end
 
-    def self.copy_doc(source, dest)
+    def self.copy_doc(source, dest, permalink=nil)
       contents = File.open(source).read
-      contents.sub!(/^# (.*)$/, "#{doc_title('\1').strip}")
+      contents.sub!(/^# (.*)$/, "#{doc_yaml('\1', permalink).strip}")
       FileUtils.mkdir_p File.dirname(dest)
       File.open(dest, 'w') {|f| f.write(contents) }
       puts "Updated #{dest} from #{source}"
     end
 
-    def self.doc_title(input)
-      <<-YAML
----
-title: "#{input.strip}"
----  
-    YAML
+    def self.doc_yaml(title, permalink)
+      yaml  = "---\n"
+      yaml += "title: \"#{title.strip}\"\n"
+      yaml += "permalink: #{permalink.strip}\n" if permalink
+      yaml += "---"
     end
   end
 end
@@ -177,6 +176,6 @@ Liquid::Template.register_tag('doc_url', Octopress::Ink::Tags::DocUrlTag)
 require 'octopress-ink/plugins/ink'
 require 'octopress-ink/plugins/asset_pipeline'
 
-Octopress::Ink.register_plugin(Ink)
+Octopress::Ink.register_plugin(Octopress::Ink::InkPlugin)
 Octopress::Ink.register_plugin(Octopress::Ink::AssetPipelinePlugin)
 

data/lib/octopress-ink/assets/doc_page.rb

@@ -44,7 +44,6 @@ module Octopress
             'docs_base_path' => plugin.docs_base_path,
           }
           @page.data['dir'] = File.dirname(plugin_path)
-          @page.data['doc_pages'] = @plugin.doc_pages
           @page
         end
 

data/lib/octopress-ink/jekyll/page.rb

@@ -35,6 +35,8 @@ module Octopress
             end
           rescue; end
 
+          super
+
           if @url && @url =~ /\/$/
             if self.ext == '.xml'
               @url = File.join(@url, "index.xml")
@@ -43,10 +45,9 @@ module Octopress
             end
           end
 
-          super
+          @url
         end
       end
     end
   end
 end
-

data/lib/octopress-ink/plugin.rb

@@ -110,7 +110,7 @@ module Octopress
       #
       def doc_pages
         if !@docs.empty?
-          @docs.clone.map { |d|
+          @doc_pages ||= @docs.clone.map { |d|
             page = d.page
             title   = page.data['link_title'] || page.data['title'] || page.basename
             url = File.join('/', docs_base_path, page.url.sub('index.html', ''))

data/lib/octopress-ink/plugins.rb

@@ -97,16 +97,16 @@ module Octopress
       # returns: Array of plugin doc pages
       #
       def self.doc_pages
-        plugins.clone.map { |p|
+        plugin_docs = {}
+        plugins.clone.map do |p|
           if pages = p.doc_pages
-            { 
+            plugin_docs[p.slug] = {
               "name" => p.name,
               "pages" => pages
             }
-          else
-            nil
           end
-        }.compact
+        end
+        plugin_docs
       end
 
       def self.include(name, file)

data/lib/octopress-ink/plugins/ink.rb

@@ -1,25 +1,28 @@
-class Ink < Octopress::Ink::Plugin
-  def configuration
-    {
-      name:        "Octopress Ink",
-      slug:        "ink",
-      assets_path: Octopress::Ink.gem_dir('assets'),
-      version:     Octopress::Ink::VERSION,
-      description: "Octopress Ink is a plugin framework for Jekyll",
-      website:     "http://octopress.org/docs/ink"
-    }
-  end
+module Octopress
+  module Ink
+    class InkPlugin < Octopress::Ink::Plugin
+      def configuration
+        {
+          name:        "Octopress Ink",
+          slug:        "ink",
+          assets_path: Octopress::Ink.gem_dir('assets'),
+          version:     Octopress::Ink::VERSION,
+          description: "Octopress Ink is a plugin framework for Jekyll",
+          website:     "http://octopress.org/docs/ink"
+        }
+      end
 
-  def docs_base_path
-    'docs/ink'
-  end
+      def docs_base_path
+        'docs/ink'
+      end
 
-  def info(options)
-    if options['docs']
-      super
-    else
-      ''
+      def info(options)
+        if options['docs']
+          super
+        else
+          ''
+        end
+      end
     end
   end
 end
-

data/lib/octopress-ink/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Ink
-    VERSION = "1.0.0.alpha.42"
+    VERSION = "1.0.0.alpha.43"
   end
 end

data/octopress-ink.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "jekyll", "~> 1.4.3"
+  spec.add_runtime_dependency "jekyll", "~> 1.5", ">= 1.5.0"
   spec.add_runtime_dependency "sass", "~> 3.3.0"
 
   spec.add_development_dependency "octopress"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-ink
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.42
+  version: 1.0.0.alpha.43
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: '1.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.4.3
+        version: '1.5'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +114,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- assets/docs/_configuration.markdown
+- assets/docs/_plugin-template.markdown
+- assets/docs/creating-a-gem.markdown
+- assets/docs/creating-a-plugin.markdown
+- assets/docs/index.markdown
+- assets/docs/plugin-reference.markdown
 - lib/octopress-ink.rb
 - lib/octopress-ink/assets.rb
 - lib/octopress-ink/assets/asset.rb