jekyll-asciidoc 1.0.0.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c945c1ab8b0b9f0d1d712dfcb56270a607ce1f60
+  data.tar.gz: 6851d397d5074be07773dedfc8d1a68bbc3415e8
+SHA512:
+  metadata.gz: cad0f06fa92eb33550ebb956654fbe2201f7e6b89516ea60dab20b0d5585a91c9a6491c06e6e476b297a5be9b8324e487d3892c6093585a86959866c0d910d45
+  data.tar.gz: 68041fc55d6688e1684d2a7357c9158d47f34953f637e73335f2278323948a41c4d0d390ea0beb2c5dd431815a2d1ebd8c4845687c7527e9413fed8e58755fdf

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (C) 2013 Dan Allen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,146 @@
+= Jekyll AsciiDoc Plugin (powered by Asciidoctor)
+Dan Allen <https://github.com/mojavelinux[@mojavelinux]>
+
+A http://jekyllrb.com[Jekyll] plugin that converts http://asciidoc.org[AsciiDoc] files in your site source to HTML pages using http://asciidoctor.org[Asciidoctor].
+
+The plugin consists of three extensions:
+
+`Jekyll::Converters::AsciiDocConverter`::
+  Converts AsciiDoc files to HTML
+`Jekyll::Generators::AsciiDocPreprocessor`::
+  Promotes select AsciiDoc attributes to Jekyll front matter (e.g., title, author, page-layout)
+`Jekyll::Filters.asciidocify`::
+  A Liquid filter for converting AsciiDoc content to HTML using the AsciiDocConverter
+
+All these extensions are included in the file `lib/asciidoc_plugin.rb`.
+
+== Installation
+
+The plugin depends on the Asciidoctor gem (named http://rubygems.org/gems/asciidoctor[asciidoctor]).
+You can install the gem using:
+
+ $ gem install asciidoctor
+
+If you are using Bundler to manage the dependencies in your Jekyll project, then add the Asciidoctor gem instead to your `Gemfile` (below the Jekyll gem, named jekyll):
+
+[source,ruby]
+source 'https://rubygems.org'
+gem 'jekyll'
+gem 'asciidoctor'
+
+Then, run the Bundler install command, `bundle`:
+
+ $ bundle
+
+=== Using a release
+
+First, install the Jekyll AsciiDoc gem (named `jekyll-asciidoc`):
+
+ $ gem install jekyll-asciidoc`
+
+If you are using Bundler to manage the dependencies, add the `jekyll-asciidoc` gem to your `Gemfile`:
+
+[source,ruby]
+gem 'jekyll-asciidoc'
+
+Then, run the Bundler command to install it:
+
+ $ bundle
+
+Finally, add the `jekyll-asciidoc` gem to the list of gems for Jekyll to load in your site's `_config.yml` file:
+
+[source,yaml]
+gems:
+  - jekyll-asciidoc
+
+=== Using the development version
+
+To install the development version of this plugin, copy `lib/asciidoc_plugin.rb` to the `_plugins` directory in the root of your site source.
+
+NOTE: If no `_plugins` directory exists, you need to first create it.
+
+== Creating Pages
+
+To add a page composed in AsciiDoc, simply add an AsciiDoc file to the root of the project with an AsciiDoc file extension.
+
+.sample.adoc
+[source,asciidoc]
+....
+---
+---
+= Sample Page
+:layout: page
+:permalink: /page/
+
+This is a sample page composed in AsciiDoc.
+Jekyll converts it to HTML using http://asciidoctor.org[Asciidoctor].
+
+[source,ruby]
+----
+puts "Hello, World!"
+----
+....
+
+IMPORTANT: The AsciiDoc file must have a Markdown-style front matter header or else it won't be recognized as a page.
+You can use an empty front matter header, as shown above, or you can define all your document metadata (e.g., document title) in the front matter instead of AsciiDoc attributes.
+
+You can now build your site using:
+
+ $ jekyll build
+ 
+and preview it using:
+
+ $ jekyll serve
+ 
+IMPORTANT: If you use the `--safe` option, the AsciiDoc plugin will not be activated.
+The `--safe` flag disables third-party plugins such as this one.
+
+== Configuration (Optional)
+
+By default, this plugin uses Asciidoctor to convert AsciiDoc files.
+Since Asciidoctor is the only option, the default setting is equivalent to the following configuration in `_config.yml`:
+
+[source,yaml]
+asciidoc: asciidoctor
+
+To tell Jekyll which extensions to recognize as AsciiDoc files, add the following line to your `_config.yml`:
+
+[source,yaml]
+asciidoc_ext: asciidoc,adoc,ad
+
+The extensions shown in the previous listing are the default values, so you don't need to specify this option if those defaults are sufficient.
+
+To pass additional attributes to AsciiDoc, or override the default attributes defined in the plugin, add the following lines to your `_config.yml`:
+
+[source,yaml]
+asciidoctor:
+  attributes:
+    - hardbreaks!
+    - source-highlighter=pygments
+    - pygments-css=style
+
+=== Hard line breaks
+
+The Jekyll AsciiDoc integration is configured to preserve hard line breaks in paragraph content by default.
+Since many Jekyll users are used to writing in GitHub-flavored Markdown (GFM), this default was selected to ease the transition to AsciiDoc.
+If you want the standard AsciiDoc behavior of collapsing hard line breaks in paragraph content, add the following settings to your site's `_config.yml` file:
+
+[source,yaml]
+asciidoctor:
+  attributes:
+    - hardbreaks!
+
+If you already have AsciiDoc attributes defined in the `_config.yml`, the `hardbreaks!` attribute should be added as a sibling entry in the YAML collection.
+
+== GitHub Pages
+
+GitHub doesn't (yet) whitelist the AsciiDoc plugin, so you can only run it on your own machine.
+
+TIP: GitHub needs to hear from enough users that they want to plugin in order to enable it.
+Our recommendation is to keep lobbying for them to enable it.
+
+You can automate publishing of the generated site to GitHub Pages using a continuous integration job.
+Refer to the tutorial http://eshepelyuk.github.io/2014/10/28/automate-github-pages-travisci.html[Automate GitHub Pages publishing with Jekyll and Travis CI^] to find step-by-step instructions to setup this job.
+You can also refer to the https://github.com/johncarl81/transfuse/tree/transfuse-jeykll-site[Tranfuse website build^] for an example in practice.
+
+Refer to the https://help.github.com/articles/using-jekyll-plugins-with-github-pages[Jekyll Plugins on GitHub Pages] for a list of the plugins currently supported on the server-side (in addition to Markdown, which isn't listed).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rake/clean'
+
+default_tasks = []
+
+begin
+  require 'bundler/gem_tasks'
+  default_tasks << :build
+rescue LoadError
+end
+
+task :default => default_tasks unless default_tasks.empty?

data/lib/jekyll-asciidoc.rb

@@ -0,0 +1,153 @@
+module Jekyll
+  module Converters
+    class AsciiDocConverter < Converter
+      safe true
+
+      highlighter_prefix "\n"
+      highlighter_suffix "\n"
+
+      def initialize(config)
+        @config = config
+        @config['asciidoc'] ||= 'asciidoctor'
+        @config['asciidoc_ext'] ||= 'asciidoc,adoc,ad'
+        @asciidoctor_config = (@config['asciidoctor'] ||= {})
+        # convert keys to symbols
+        @asciidoctor_config.keys.each do |key|
+          @asciidoctor_config[key.to_sym] = @asciidoctor_config.delete(key)
+        end
+        @asciidoctor_config[:safe] ||= 'safe'
+        user_defined_attributes = @asciidoctor_config[:attributes]
+        @asciidoctor_config[:attributes] = %w(notitle! hardbreaks idprefix= idseparator=- linkattrs)
+        unless user_defined_attributes.nil?
+          @asciidoctor_config[:attributes].concat(user_defined_attributes)
+        end
+        @asciidoctor_config[:attributes].push('env-jekyll')
+      end
+
+      def setup
+        return if @setup
+        case @config['asciidoc']
+          when 'asciidoctor'
+            begin
+              require 'asciidoctor'
+              @setup = true
+            rescue LoadError
+              STDERR.puts 'You are missing a library required to convert AsciiDoc files. Please run:'
+              STDERR.puts '  $ [sudo] gem install asciidoctor'
+              raise FatalException.new("Missing dependency: asciidoctor")
+            end
+          else
+            STDERR.puts "Invalid AsciiDoc processor: #{@config['asciidoc']}"
+            STDERR.puts "  Valid options are [ asciidoctor ]"
+            raise FatalException.new("Invalid AsciiDoc process: #{@config['asciidoc']}")
+        end
+        @setup = true
+      end
+      
+      def matches(ext)
+        rgx = "\.(#{@config['asciidoc_ext'].tr ',', '|'})$"
+        ext =~ Regexp.new(rgx, Regexp::IGNORECASE)
+      end
+
+      def output_ext(ext)
+        '.html'
+      end
+
+      def convert(content)
+        setup
+        case @config['asciidoc']
+        when 'asciidoctor'
+          Asciidoctor.render(content, @config['asciidoctor'])
+        else
+          warn 'Unknown AsciiDoc converter. Passing through raw content.'
+          content
+        end
+      end
+
+      def load(content)
+        setup
+        case @config['asciidoc']
+        when 'asciidoctor'
+          Asciidoctor.load(content, :parse_header_only => true)
+        else
+          warn 'Unknown AsciiDoc converter. Cannot load document header.'
+          nil
+        end
+      end
+    end
+  end
+
+  module Generators
+    # Promotes select AsciiDoc attributes to Jekyll front matter
+    class AsciiDocPreprocessor < Generator
+      def generate(site)
+        asciidoc_converter = site.getConverterImpl(Jekyll::Converters::AsciiDocConverter)
+        asciidoc_converter.setup
+        key_prefix = (site.config['asciidoc_key_prefix'] || 'jekyll-')
+        key_prefix_len = key_prefix.length
+        site.pages.each do |page|
+          if asciidoc_converter.matches(page.ext)
+            doc = asciidoc_converter.load(page.content)
+            next if doc.nil?
+
+            page.data['title'] ||= doc.doctitle
+            page.data['author'] = doc.author unless doc.author.nil?
+
+            doc.attributes.each do |key, val|
+              if key.start_with?(key_prefix)
+                page.data[key[key_prefix_len..-1]] ||= val
+              end
+            end
+
+            unless page.data.has_key? 'layout'
+              if doc.attr? 'page-layout'
+                page.data['layout'] ||= doc.attr 'page-layout'
+              else
+                page.data['layout'] ||= 'default'
+              end
+            end
+          end
+        end
+        site.posts.each do |post|
+          if asciidoc_converter.matches(post.ext)
+            doc = asciidoc_converter.load(post.content)
+            next if doc.nil?
+
+            post.data['title'] ||= doc.doctitle
+            post.data['author'] = doc.author unless doc.author.nil?
+            # TODO carry over date
+            # setting categories doesn't work here, we lose the post
+            #post.data['categories'] ||= (doc.attr 'categories') if (doc.attr? 'categories')
+
+            doc.attributes.each do |key, val|
+              if key.start_with?(key_prefix)
+                post.data[key[key_prefix_len..-1]] ||= val
+              end
+            end
+
+            unless post.data.has_key? 'layout'
+              if doc.attr? 'page-layout'
+                post.data['layout'] ||= doc.attr 'page-layout'
+              else
+                post.data['layout'] ||= 'post'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  module Filters
+    # Convert an AsciiDoc string into HTML output.
+    #
+    # input - The AsciiDoc String to convert.
+    #
+    # Returns the HTML formatted String.
+    def asciidocify(input)
+      site = @context.registers[:site]
+      converter = site.getConverterImpl(Jekyll::Converters::AsciiDocConverter)
+      converter.convert(input)
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-asciidoc
+version: !ruby/object:Gem::Version
+  version: 1.0.0.alpha.1
+platform: ruby
+authors:
+- Dan Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: A Jekyll plugin that converts AsciiDoc files in your site source to HTML
+  pages using Asciidoctor.
+email:
+- dan.j.allen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.adoc
+- Rakefile
+- lib/jekyll-asciidoc.rb
+homepage: https://github.com/asciidoctor/jekyll-asciidoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Jekyll plugin that converts AsciiDoc files in your site source to HTML
+  pages using Asciidoctor.
+test_files: []
+has_rdoc: