octopress-ink 1.0.0.rc.19 → 1.0.0.rc.20

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aa2d2440952a5f6b283baf69eb97ad02476a89d
-  data.tar.gz: 4ec408b10ddb22ff6fad321724109f0f93e5e855
+  metadata.gz: ed486bb3213b7ddd8920731ab620c538a140e1bb
+  data.tar.gz: 573c19ef7bccc8713c6464055af7cd320d5fcb4f
 SHA512:
-  metadata.gz: e7c73835a88896db10a813a3d44fae35c464ab0ac5e501e7bd076c81b25d47212a879f89ab735f5e357f606596439b20c421c4e7ddd7603d87058f5e5f8924a0
-  data.tar.gz: d6162bf2dc6319d26329bcbd63287e21475bd87b39b25f578edf38c6e776e92fd37b91fe70bd4c2face3a88253b78272fbcbbdf1130b45333145e8c86d1bc6bd
+  metadata.gz: 63cae56453a4f71770fb506e3bc7a7b0f708b8bc734ac2835052af17a1027e2cc74e5a105b55e20878f701e1371be1384940118a008f002dbe43930ae4b4af37
+  data.tar.gz: 1eb8d270480c0fba04b9c6093cec06e8e94ebc8e4bf2cff1b4e9997d8cbfa444b3d0d362de56d308f9c16d670e5ca90c67e9d46419555d5eac9d6a11a75ceb14

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+### 1.0.0 RC20 - 2014-12-13
+
+- Improvements to scaffold and docs.
+
 ### 1.0.0 RC19 - 2014-12-09
 
 - Fixes to be compatible with the latest versions of Octopress and Jekyll.

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

@@ -17,11 +17,14 @@ require "octopress-ink"
 Octopress::Ink.add_plugin({
   name:          "My Plugin",
   slug:          "my-plugin",
-  assets_path:   File.expand_path(File.join(File.dirname(__FILE__), '../assets')),
+  path:          File.expand_path(File.join(File.dirname(__FILE__), "../")),
   type:          "plugin",
+
+  # Metadata which is displayed with plugin info
   version:       MyPlugin::VERSION,
-  description:   "",
-  website:       ""
+  description:   "My plugin does awesome stuff",
+  source_url:    "https://github.com/user/project",
+  website:       ""                                
 })
 ```
 
@@ -36,6 +39,7 @@ The configuration options are as follows.
 | 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 |
+| source_url    | Optional: Direct people to the GitHub project (or elsewhere) |
 
 Note: For themes, the slug will be set to `theme`. This makes it easy for users to work with any theme with a consistent slug name.
 
@@ -141,7 +145,7 @@ Note: Assets are copied at build time and assets will not overwrite an existing
 | images          | `cat.gif` is copied to `_site/images/plugin_slug/cat.gif`.                                            |
 | javascripts     | `boom.js` is combined with all plugin javascripts into a single fingerprinted file.                     |
 | stylesheets     | `theme.scss` and `print.css` are combined with all plugin stylesheets into a single fingerprinted file. |
-| docs            | Add documentation files for your plugin here. Users will be able to read it by running `octopress docs`. [read more]({% doc_url plugin-documentation %}) |
+| docs            | Add documentation files for your plugin here. Users will be able to read it by running `octopress docs`. |
 
 
 ### Layouts

data/assets/docs/index.markdown

@@ -11,7 +11,7 @@ Octopress Ink helps developers create plugins and themes which integrate seamles
 - Customization is simple and consistent.
 - Easily view documentation for your unique setup, even offline.
 
-[Using Octopress Ink plugins →]({% doc_url for-users %})
+[Using Octopress Ink plugins →](#add-a-link)
 
 #### Benefits For Developers
 
@@ -19,7 +19,7 @@ Octopress Ink helps developers create plugins and themes which integrate seamles
 - Easily convert plugins you've already written.
 - Plugins automatically integrate with the Octopress CLI.
 
-[Developing with Octopress Ink →]({% doc_url for-developers %})
+[Developing with Octopress Ink →](#add-a-link)
 
 #### Shipping assets
 - Asset pipeline

data/assets/docs/plugin-reference.markdown

@@ -3,7 +3,7 @@ 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/ %}).
+Octopress Ink plugins should be distributed as Ruby gems.
 
 ### Plugin Template
 
@@ -14,12 +14,15 @@ require "octopress-ink"
 
 Octopress::Ink.add_plugin({
   name:          "My Plugin",
-  slug:          "my-plugin",
-  assets_path:   File.expand_path(File.join(File.dirname(__FILE__), '../assets')),
+  slug:          "my-plugin", # optional (derived from name if not present)
+  path:          File.expand_path(File.join(File.dirname(__FILE__), "../")),
   type:          "plugin",
+
+  # Optional (but awesome) metadata
   version:       MyPlugin::VERSION,
-  description:   "",
-  website:       ""
+  description:   "My plugin does awesome stuff",
+  source_url:    "https://github.com/user/project",
+  website:       ""                                
 })
 ```
 

data/lib/octopress-ink.rb

@@ -12,16 +12,6 @@ require 'octopress-ink/configuration'
 require 'octopress-ink/jekyll/hooks'
 
 module Octopress
-  def self.site=(site)
-    # Octopress historically used site.title
-    # This allows theme developers to expect site.name
-    # in consistancy with Jekyll's scaffold config 
-    
-    site.config['name'] ||= site.config['title']
-
-    @site = site
-  end
-
   module Ink
 
     autoload :Assets,               'octopress-ink/assets'
@@ -223,7 +213,9 @@ Liquid::Template.register_tag('js_asset_tag', Octopress::Ink::Tags::JavascriptTa
 
 Octopress::Docs.add({
   name:        "Octopress Ink",
+  description: "A framework for creating Jekyll quality themes and plugins",
   slug:        "ink",
-  dir:         File.expand_path(File.join(File.dirname(__FILE__), "../")),
+  path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+  source_url:  "https://github.com/octopress/ink",
   base_url:    "docs/ink"
 })

data/lib/octopress-ink/commands/new.rb

@@ -168,7 +168,7 @@ _site
         def self.add_simple_plugin(mod)
           mod  = "#{@settings[:require_version]}\n"
           mod += "require 'octopress-ink'\n"
-          mod += "\nOctopress::Ink.add_plugin({\n#{indent(plugin_config)}\n})"
+          mod += "\nOctopress::Ink.add_plugin({\n#{indent(plugin_config)}\n})\n"
         end
 
 
@@ -184,8 +184,9 @@ slug:          "#{@settings[:type] == 'theme' ? 'theme' : @settings[:name]}",
 path:          File.expand_path(File.join(File.dirname(__FILE__), "../")),
 type:          "#{@settings[:type]}",
 version:       #{@settings[:version]},
-description:   "",
-website:       ""
+description:   "",                                # What does your theme/plugin do?
+source_url:    "https://github.com/user/project", # <- Update info
+website:       ""                                 # Optional project website
           HERE
           config.rstrip
         end

data/lib/octopress-ink/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Ink
-    VERSION = "1.0.0.rc.19"
+    VERSION = "1.0.0.rc.20"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-ink
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.19
+  version: 1.0.0.rc.20
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-10 00:00:00.000000000 Z
+date: 2014-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll