octopress-ink 1.0.0.rc.11 → 1.0.0.rc.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 576099a0e49e1ab0edc2d5cbb5a9e16200a4394f
-  data.tar.gz: e5eb8df4eda75bfc27abfe48f0b20e293fe84525
+  metadata.gz: 48037693d08748489adee87f801cb143f5a320fd
+  data.tar.gz: 7ffb7e286fd7664305502dbbb98dd6e32c55c6fc
 SHA512:
-  metadata.gz: c3bee656fcd73fd9c9fa3e24eb69d26fc7cd978838c25a5a38af9daa8b6e5c18cba20393146d3cfd026ead3f5a415a24cfbbdfea13d220762209c99633c077c5
-  data.tar.gz: 1336166f60125b7cab46bacbcde7f4a3d50f26672f63a17a1c641a6323c3ae0f08d921a93dd468b24ac4c756db9badf607884f5e70830869a6f96369fb20702c
+  metadata.gz: c1021fc8290f4d780810aa696046f60d9fe63c49d370817d4eb0514445f05cee27ce32bffcbaf39464166599b0418d5a609c5d5f062b829b7ae21d0b0bb5931e
+  data.tar.gz: 4b20db2aec8fc8bdcdaba7b17708e9c6d0543dee05a5c54e645e27f07a3631e669ab14add044f72a6ee779c60bf9dd9e819b76da591c5047af7db3844df28ed1

data/.gitignore

@@ -19,3 +19,4 @@ tmp
 .sass-cache
 test/site
 .code-highlighter-cache
+_site

data/.travis.yml

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

data/CHANGELOG.md

@@ -1,13 +1,22 @@
 # Changelog
 
-## Current released version
+### 1.0.0 RC13 - 2014-08-11
+
+- Fixed an issue with asset tags
+
+### 1.0.0 RC12 - 2014-08-03
+
+- Extracted all tags to separate projects under [github.com/octopress](https://github.com/octopress).
+- Now the only tag provided by default is [include-tag](https://github.com/octopress/include-tag).
+- Switched from jekyll-page-hooks to octopress-hooks.
+- Extracted link post feature as a separate plugin [octopress-linkblog](https://github.com/octopress/linkblog)
+- Extracted page date feature as a separate plugin [octopress-date-format](https://github.com/octopress/date-format)
+- Extracted Autoprefixer a separate plugin [octopress-autoprefixer](https://github.com/octopress/autoprefixer)
 
 ### 1.0.0 RC11 - 2014-06-27
 
 - Fixed: Render tag properly processes local variables.
 
-## Past versions
-
 ### 1.0.0 RC10 - 2014-06-26
 
 - Render tag does a better job of preserving {% raw %} escaped content.

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

@@ -3,7 +3,7 @@ title: "Create an Octopress Ink Plugin"
 permalink: /guides/creating-a-plugin/
 ---
 
-*This guide assumes you have already installed Git, and Ruby 1.9.3 or greater.*
+*This guide assumes you have already installed Git, and have Ruby 1.9.3 or greater.*
 
 Octopress Ink plugins are distributed as ruby gems so you'll need to create an account at [RubyGems.org](https://rubygems.org/sign_up) if you haven't yet. Also, be sure to install the [Bundler](http://bundler.io) gem.
 
@@ -17,6 +17,8 @@ The configuration options are as follows.
 
 {% render ./_configuration.markdown %}
 
+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.
+
 Next you simply need an `assets` directory at the root of your gem with subdirectories for each asset type you plan to use in your plugin.
 
 If you have a gem-based plugin which you'd like to convert into an Octopress Ink plugin, this should make it easy for you.
@@ -29,21 +31,21 @@ This will add the asset directories, create a demo site, and print out a plugin
 
 ### Create a plugin from scratch
 
-To create a new plugin named "Spicy Baconnaise" run:
+To create a new plugin named "Some Plugin" run:
 
 ```sh
-$ octopress ink new spicy_baconnaise
+$ octopress ink new some_plugin
 ```
 
 This does the following.
 
 - Creates a new gem using Bundler's gem scaffolding.
 - It adds `octopress` and `octopress-ink` as dependencies in the gemspec.
-- An Octopress Ink plugin template is added to `lib/spicy_baconnaise.rb`.
+- An Octopress Ink plugin template is added to `lib/some_plugin.rb`.
 - `assets/` contains empty asset directories.
 - `demo/` contains a blank Jekyll site with your plugin already integrated for easy testing.
 
-Here's what the new `spicy_baconnaise` directory looks like.
+Here's what the new `some_plugin` directory looks like.
 
 ```
 assets/
@@ -57,33 +59,33 @@ assets/
   pages/
   stylesheets/
 lib/
-  spicy_baconnaise/
+  some_plugin/
     version.rb
-  spicy_baconnaise.rb
+  some_plugin.rb
 demo/
   _layouts/
   _posts/
   Gemfile
   index.html
-spicy_baconnaise.gemspec
+some_plugin.gemspec
 Gemfile
 LICENSE.txt
 Rakefile
 README.md
 ```
 
-In `lib/spicy_baconnaise.rb` you'll find an Octopress Ink plugin created specifically for your gem.
+In `lib/some_plugin.rb` you'll find an Octopress Ink plugin created specifically for your gem.
 
 ```ruby
 require 'lib/version'
 require 'octopress-ink'
 
 Octopress::Ink.add_plugin({
-  name:          "Spicy Baconnaise"
-  slug:          "spicy_baconnaise",
+  name:          "Some Plugin"
+  slug:          "some_plugin",
   assets_path:   File.expand_path(File.join(File.dirname(__FILE__), "../assets")),
-  type:          "spicy_baconnaise",
-  version:       SpicyBaconnaise::Version,
+  type:          "some_plugin",
+  version:       SomePlugin::Version,
   description:   "",
   website:       ""
 })
@@ -104,21 +106,81 @@ plugin. To finish setting up your plugin, you'll need to add the plugin template
 
 ## Plugin assets
 
-Octopress Ink plugins make it super easy to integrate assets with any Jekyll site. Your plugin should have an assets directory called `assets`. Typically this should be in the root directory of your gem. Inside `assets` there will be folders for each asset type you plan to use.
-
-Note: Assets are only copied at build time and assets will not overwrite an existing file.
+Octopress Ink plugins make it super easy to integrate assets with any Jekyll site. Your plugin should have an `assets` directory,
+typically in the root directory of your gem. Inside `assets` there will be folders for each asset type your plugin uses plan to use.
 
+Note: Assets are copied at build time and assets will not overwrite an existing file.
 
 | Asset directory |  Description                                    |
 |:----------------|:------------------------------------------------|
-| 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 %}) |
-| fonts           | `wingdings.ttf` is copied to `_site/fonts/[plugin_slug]/wingdings.ttf`.                                 |
-| 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. |
-| includes        | Includes are available to users by {% raw %}`{% include [plugin_slug]:some_file.html %}`{% endraw %}.   |
-| layouts         | Users can add layouts by setting `layout: [plugin_slug]:some_layout` in a page's YAML front-matter.     |
+| layouts         | Users can add layouts by setting `layout: plugin_slug:some_layout` in a page's YAML front-matter.     |
+| includes        | Includes are available to users by `{% raw %}{% include plugin_slug:some_file.html %}{% endraw %}`.   |
 | pages           | `pages/feed.xml` is processed and copied to `_site/feed.xml` at build time. Setting `permalink: feed/` renders to `_site/feed/index.xml`. |
 | files           | `files/favicon.ico` is copied to `_site/favicon.ico`.                                                   |
+| fonts           | `wingdings.ttf` is copied to `_site/fonts/plugin_slug/wingdings.ttf`.                                 |
+| 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 %}) |
+
 
+### Layouts
+
+Layouts will probably mostly be useful if you're developing a theme. For a typical theme you'll probably have three layouts:
+
+```
+assets/
+  layouts/
+    default.html
+    page.html
+    post.html
+```
+
+Here's a example of a simple `default.html` layout.
+
+```
+<!DOCTYPE html>
+<meta charset="utf-8">
+<html>
+  <head>
+    <title>{{ page.title }} - {{ site.title }}</title>
+    {% octopress_css %}
+  </head>
+  <body>
+    {{ content }}
+    {% octopress_js %}
+  </body>
+</html>
+```
+
+You'll notice the `{% octopress_css %}` and `{% octopress_js %}` tags. These are special tags that come with Octopress Ink and output the `<link>` and `<script>` tags from the Octopress Ink asset pipeline.
+
+A `page.html` or `post.html` might look like this:
+
+```
+---
+layout: theme:default
+---
+<article>
+<h1>{{ page.title }}</h1>
+{{ content }}
+</article>
+```
+
+You'll notice that the default layout is included with `layout: theme:default`. Of course, if your plugin's slug was `baconnaise` you'd use `layout: baconnaise:default`.
+
+Users can override the theme's default layout by adding a file to `_plugins/theme/layouts/default.html`. Now the theme's page and post layouts will 
+load the user's default layout instead of loading it from the theme's assets. If your plugin's slug was `baconnaise` the user could override the layout by placing a
+file at `_plugins/baconnaise/layouts/default.html`.
+
+### Includes
+
+Includes are how you store a partial of code to be reused in several locations. For example, you might want to share site navigation between several layouts.
+
+```
+assets/
+  includes/
+    navigation.html
+```
 
+To include this partial, use an include tag, but add the plugin slug before the filename like this `{% include plugin_slug:navigation %}`.

data/assets/docs/plugin-reference.markdown

@@ -19,4 +19,4 @@ The configuration options are as follows:
 
 ### Plugin Assets
 
-You can set `assets_path` to point wherever you like inside your gem file, but in this case we have it pointing to the `assets` directory 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.
+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/assets/docs/working-with-plugins.markdown

@@ -0,0 +1,188 @@
+---
+title: "Working with Octopress Ink Plugins"
+permalink: /working-with-plugins/
+---
+
+## Installing plugins
+
+Octopress Ink plugins are distributed as Ruby gems. This makes them really easy to add to any Jekyll site.
+If you were going to install the [octopress-codefence](https://github.com/octopress/codefence) plugin, first you'd need to install the gem.
+
+#### Using Bundler
+
+If you are using [Bundler](http://bundler.io), simply add it to your Gemfile in the `:octopress` group and run `bundle`. Octopress will automatically load the plugin when you build your site.
+
+```ruby
+group :octopress do
+  gem 'octopress-codefence'
+end
+```
+
+#### Manually
+
+If you aren't using Bundler, first install the gem manually.
+
+```sh
+$ gem install octopress-codefence
+```
+
+Then add it to your gems list in your `_config.yml`.
+
+```
+gems:
+  - octopress-codefence
+```
+
+Now whenever you build your site, Jekyll will automatically load the Octopress Codefence plugin.
+
+## Listing plugins
+
+If you have installed the `octopress` gem. You can easily learn about the plugins you have installed.
+
+```
+$ octopress ink list [PLUGIN] [options]        # List basic info about all installed plugins.
+$ octopress ink list --all                     # List detailed info about all plugins.
+$ octopress ink list --stylesheets             # List stylesheets from all plugins with stylesheets.
+$ octopress ink list awesome-plugin            # List everything about a specific plugin.
+$ octopress ink list awesome-plugin --layouts  # List layouts from a specific plugin.
+$ octopress ink list theme --config            # List your theme's default configuration opitons.
+```
+
+Here's an example of what `octopress ink list` might print with `octopress-codefence` and `octopress-solarized` installed.
+
+```
+Octopress Ink - v1.0.0.0
+ Octopress Codefence (octopress-codefence) - v1.0.1 - Generate beautiful code snippets with advanced features on any Jekyll site.
+ Octopress Solarized (octopress-solarized) - v1.0.0 - Style code snippets with Ethan Schoonover's Solarized theme (tweaked a bit).
+```
+
+This lists the Octopress Ink version and each plugins along with some basic information. Here are some of the commands you can use. Run
+`octopress ink list --help` to see all of the options.
+
+Here's an example of the output from running `octopress ink list awesome-plugin`.
+
+```
+Plugin: Some Awesome Theme
+Slug: theme
+This theme is the awesome one.
+================================================================================
+ layouts:
+  - default.html
+  - post.html
+  - page.html
+
+ includes:
+  - navigation.html
+  - header.html
+  - footer.html
+
+ pages:
+  - feed.xml                           /feed/index.html
+  - index.html                         /index.html
+  - archive.html                       /archives/index.html
+
+ sass:
+  - _colors.scss
+  - _layout.scss
+  - theme.scss
+
+ files:
+  - favicon.ico
+```
+
+## Customizing plugins
+
+Assets for Octopress Ink plugins (templates, images, stylesheets, etc.) all live inside the gem and are
+only integrated with your site during the build process. Here's how you can customize a plugin's assets.
+
+Each plugin has a slug, for a theme this slug is always `theme`, but for other plugins it will be different. Run `octopress ink list` and
+the plugin slugs will be listed after the plugin's name inside the parenthesis. Octopress Ink will look in `_plugins/[your_plugin_slug]/` for your plugin customizations.
+
+For example, If you want to override the `default.html` layout for a theme, you'd add a file in your site's source directory at
+`_plugins/theme/layouts/default.html`. Now when your site is built, Octopress Ink will override the theme's default layout with your
+custom version.
+
+The easiest way to make changes to a theme is to copy its assets into your override directories and make changes there.
+
+### Copying plugin assets
+
+If you have installed the `octopress` gem. You can copy a plugin's assets to it's corresponding override directory using the `octopress
+ink copy` command. Here are some examples.
+
+```
+$ octopress ink copy <PLUGIN> [options]
+$ octopress ink copy theme                     # Copy all theme assets to _plugins/theme/.
+$ octopress ink copy theme --stylesheets       # Copy theme Sass or CSS to _plugins/theme/stylesheets/.
+$ octopress ink copy theme --config            # Copy the theme's configuration file to _plugins/theme/config.yml.
+$ octopress ink copy magic-plugin --layouts    # Copy layouts for magic-plugin to _plugin/magic-plugin/layouts/.
+$ octopress ink copy magic-plugin --path test  # Copy all assets for magic-plugin to ./test
+```
+
+To make modifications to the default layout for your theme you might.
+
+1. Run `octopress ink copy theme --layouts`.
+2. Go to `_plugins/theme/layouts/` and remove all files except `default.html`.
+3. Make necessary modifications to `default.html`.
+
+If you decide that you want to revert to the original layout, simply remove your overriding copy and Octopress Ink will read the layout
+from the gem once again.
+
+This same system works for any type of asset listed with the `octopress ink list` command.
+
+### Disabling plugin assets
+
+You can disable assets from your plugin's configuration file. Disable individual assets, or all of one type of asset. Here's an example of how to disable assets on a theme.
+
+```yaml
+# _plugins/theme/config.yml
+disable:
+  fonts: true                          # disable all fonts
+  files: favicon.ico                   # disable a specific file
+  pages:                               # disable multiple pages
+    - archive.html
+    - feed.xml
+```
+
+Any asset can be disabled except for layouts, includes and Sass partials. Layouts and includes are only added to a site when you manually
+include them, so disabling them isn't necessary. Sass partials can't be disabled because they aren't added directly to Jekyll,
+but are instead included by Sass files.
+
+You can verify that you've disabled assets by running `octopress ink list <PLUGIN>`. Assets which are disabled will be marked like this.
+
+```
+ fonts:  
+  - awesome.ttf                   disabled
+  - awesome.woff                  disabled
+  - awesome.eot                   disabled
+
+ files:
+  - favicon.ico                   disabled
+  - robots.txt         
+
+ pages:
+  - archive.html                  disabled
+  - feed.xml                      disabled
+  - index.html                    /index.html
+```
+
+### Changing URLs for plugin pages
+
+You can override URLs for plugin pages in your plugin's configuration. Under `page_permalinks` add the file's name (not including the extension) as a key, followed by
+your custom permalink. Here's an example.
+
+```
+page_permalinks:
+  index: posts/        # index.html is moved to /posts/index.html
+  feed: rss/           # feed.xml is moved to /rss/index.xml
+```
+
+Now when you run `octopress ink list <PLUGIN> --pages` you'll see your custom URLs listed by the pages.
+
+```
+ pages:
+  - archive.html                  /archive.html
+  - feed.xml                      /rss/index.xml
+  - index.html                    /posts/index.html
+```
+
+

data/lib/octopress-ink.rb

@@ -1,22 +1,40 @@
 require 'jekyll'
 require 'sass'
 require 'uglifier'
-require 'autoprefixer-rails'
 require 'digest/md5'
-require 'jekyll-page-hooks'
+require 'octopress'
+require 'octopress-hooks'
+require 'octopress-filters'
 
 require 'octopress-ink/version'
 
-require 'octopress-ink/utils'
-require 'octopress-ink/generators/plugin_assets'
+require 'octopress-ink/configuration'
 require 'octopress-ink/jekyll/hooks'
 
 module Octopress
+  def self.site(options={})
+    @site ||= init_site(options)
+  end
+
+  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
+
+  def self.init_site(options)
+    Jekyll.logger.log_level = :error
+    site = Jekyll::Site.new(Jekyll.configuration(options))
+    Jekyll.logger.log_level = :info
+    site
+  end
+
   module Ink
 
-    autoload :Configuration,        'octopress-ink/configuration'
-    autoload :Helpers,              'octopress-ink/helpers'
-    autoload :Filters,              'octopress-ink/filters'
     autoload :Assets,               'octopress-ink/assets'
     autoload :Page,                 'octopress-ink/jekyll/page'
     autoload :StaticFile,           'octopress-ink/jekyll/static_file'
@@ -59,69 +77,6 @@ module Octopress
       @config ||= Configuration.config
     end
 
-    def self.site(options={})
-      unless @site
-        @site ||= init_site(options)
-      end
-
-      @site
-    end
-
-    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
-
-    def self.payload(jekyll_payload={})
-      Jekyll::Utils.deep_merge_hashes(jekyll_payload, custom_payload)
-    end
-
-    def self.custom_payload
-      unless @custom_payload
-        config = Plugins.config
-
-        payload = {
-          'plugins'   => config['plugins'],
-          'theme'     => config['theme'],
-          'octopress' => {
-            'version' => Octopress::Ink.version
-          },
-          'site' => {
-            'linkposts' => self.linkposts,
-            'articles'  => self.articles,
-          }
-        }
-
-        if Octopress::Ink.config['docs_mode']
-          payload['doc_pages'] = Octopress::Ink::Plugins.doc_pages
-        end
-
-        @custom_payload = payload
-      end
-
-      @custom_payload
-    end
-
-    def self.linkposts
-      @linkposts ||= site.posts.select {|p| p.data['linkpost']}
-    end
-
-    def self.articles
-      @articles ||= site.posts.reject {|p| p.data['linkpost']}
-    end
-
-    def self.init_site(options)
-      log_level = Jekyll.logger.log_level
-      Jekyll.logger.log_level = :error
-      site = Jekyll::Site.new(Jekyll.configuration(options))
-      Jekyll.logger.log_level = log_level
-      site
-    end
-
     def self.plugins
       Plugins.plugins
     end
@@ -144,7 +99,7 @@ module Octopress
     #
     #
     def self.list(options={})
-      site(options)
+      Octopress.site(options)
       Plugins.register
       options = {'minimal'=>true} if options.empty?
       message = "Octopress Ink - v#{VERSION}\n"
@@ -160,9 +115,11 @@ module Octopress
     end
 
     def self.plugin_list(name, options)
-      site(options)
+      config = options.delete('config') # Jekyll conflicts with this option
+      Octopress.site(options)
       Plugins.register
-      options.delete('config')
+      options['config'] = config if config
+
       if p = plugin(name)
         puts p.list(options)
       else
@@ -171,8 +128,11 @@ module Octopress
     end
 
     def self.copy_plugin_assets(name, options)
-      site(options)
+      config = options.delete('config') # Jekyll conflicts with this option
+      Octopress.site(options)
       Plugins.register
+      options['config'] = config if config
+
       path = copy_path(name, options)
 
 
@@ -190,23 +150,23 @@ module Octopress
 
     def self.copy_path(name, options)
       if path = options.delete('path')
-        full_path = File.join(Ink.site.source, path)
+        full_path = File.join(Dir.pwd, path)
         if !Dir["#{full_path}/*"].empty? && options['force'].nil?
           abort "Error: directory #{path} is not empty. Use --force to overwrite files."
         end
       else
-        full_path = File.join(Ink.site.source, Plugins.custom_dir, name)
+        full_path = File.join(Dir.pwd, Plugins.custom_dir, name)
       end
 
       full_path
     end
 
     def self.list_plugins(options={})
-      site(options)
+      Octopress.site(options)
       Plugins.register
       puts "\nCurrently installed plugins:"
       if plugins.size > 0
-        plugins.each { |plugin| puts plugin.name }
+        plugins.each { |plugin| puts plugin.name + " (#{plugin.slug})" }
       else
         puts "You have no plugins installed."
       end
@@ -250,21 +210,8 @@ module Octopress
   end
 end
 
-Liquid::Template.register_filter Octopress::Ink::Filters
-
-Liquid::Template.register_tag('include', Octopress::Ink::Tags::IncludeTag)
-Liquid::Template.register_tag('assign', Octopress::Ink::Tags::AssignTag)
-Liquid::Template.register_tag('capture', Octopress::Ink::Tags::CaptureTag)
-Liquid::Template.register_tag('return', Octopress::Ink::Tags::ReturnTag)
-Liquid::Template.register_tag('filter', Octopress::Ink::Tags::FilterTag)
-Liquid::Template.register_tag('render', Octopress::Ink::Tags::RenderTag)
-Liquid::Template.register_tag('css_asset_tag', Octopress::Ink::Tags::JavascriptTag)
-Liquid::Template.register_tag('js_asset_tag', Octopress::Ink::Tags::StylesheetTag)
-Liquid::Template.register_tag('content_for', Octopress::Ink::Tags::ContentForTag)
-Liquid::Template.register_tag('yield', Octopress::Ink::Tags::YieldTag)
-Liquid::Template.register_tag('wrap', Octopress::Ink::Tags::WrapTag)
-Liquid::Template.register_tag('abort', Octopress::Ink::Tags::AbortTag)
-Liquid::Template.register_tag('_', Octopress::Ink::Tags::LineCommentTag)
+Liquid::Template.register_tag('css_asset_tag', Octopress::Ink::Tags::StylesheetTag)
+Liquid::Template.register_tag('js_asset_tag', Octopress::Ink::Tags::JavascriptTag)
 Liquid::Template.register_tag('doc_url', Octopress::Ink::Tags::DocUrlTag)
 
 require 'octopress-ink/plugins/ink'