octopress-docs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff973bd8ad863c0093dc0550a1dfa0520ce4d2e0
+  data.tar.gz: 5e60dade12af116e5272c9780d0623b3f6308522
+SHA512:
+  metadata.gz: 53687964a722e0ff95c99e7bcfbfa5515ecdc90a43adbf4aed6cfabdc7f3b70c9cca33d4a1b18fcef16fd5bf0de24bb45f5a14705864f60496231ad6f8dcc88c
+  data.tar.gz: 4f7a24b948574c24282a40a04c3a575bddd8f92ee71bff5b384c5197289e1cc48fe3afb908ab423d15b3ae01966ba88578e1c68f2816a164b2a9b0b168a6c488

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Brandon Mathis
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Octopress::Docs
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'octopress-docs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install octopress-docs
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/octopress-docs.rb

@@ -0,0 +1,78 @@
+require "octopress"
+require "jekyll"
+require "octopress-escape-code"
+
+require "octopress-docs/version"
+require "octopress-docs/command"
+require "octopress-docs/doc"
+require "octopress-docs/tag"
+
+module Octopress
+  module Docs
+    attr_reader :pages
+    @pages = []
+
+    autoload :Doc, 'octopress-docs/doc'
+
+    def self.gem_dir(dir='')
+      File.expand_path(File.join(File.dirname(__FILE__), '../', dir))
+    end
+
+    def self.add_plugin_docs(plugin, dir, files)
+      pages = []
+      options = plugin_options(plugin).merge({
+        dir: File.join(plugin.assets_path, dir),
+      })
+
+      files.each do |doc|
+        unless doc =~ /^_/
+          opts = options.merge({file: doc})   
+          pages << add_doc_page(opts)
+        end
+      end
+
+      pages
+    end
+
+    def self.plugin_options(plugin)
+      {
+        plugin_name: plugin.name,
+        plugin_slug: plugin.slug,
+        plugin_type: plugin.type,
+        base_url: plugin.docs_base_url,
+        dir: plugin.path
+      }
+    end
+
+    def self.add(options)
+      root_docs = []
+      options[:docs] ||= %w{readme changelog}
+      options[:docs].each do |doc|
+        root_docs << add_root_doc(doc, options)
+      end
+      root_docs
+    end
+
+    # Add a single root doc
+    def self.add_root_doc(filename, options)
+      if file = select_first(options[:dir], filename)
+        add_doc_page(options.merge({file: file}))
+      end
+    end
+
+    def self.add_root_plugin_doc(plugin, filename, options={})
+      options = plugin_options(plugin).merge(options)
+      add_root_doc(filename, options)
+    end
+
+    def self.add_doc_page(options)
+      page = Docs::Doc.new(options)
+      @pages << page
+      page
+    end
+
+    def self.select_first(dir, match)
+      Dir.new(dir).select { |f| f =~/#{match}/i}.first
+    end
+  end
+end

data/lib/octopress-docs/command.rb

@@ -0,0 +1,74 @@
+module Octopress
+  module Docs
+    class Commands < Octopress::Command
+      def self.init_with_program(p)
+        p.command(:docs) do |c|
+          c.syntax 'octopress docs'
+          c.description "Launch local server with docs for Octopress v#{Octopress::VERSION} and Octopress Ink plugins."
+
+          c.option 'port', '-P', '--port [PORT]', 'Port to listen on'
+          c.option 'host', '-H', '--host [HOST]', 'Host to bind to'
+          if ENV['OCTODEV']
+            c.option 'watch', '--watch', 'Watch docs site for changes and rebuild. (For docs development)'
+          end
+          c.option 'jekyll', '--jekyll', "Launch local server with docs for Jekyll v#{Jekyll::VERSION}"
+
+          c.action do |args, options|
+            serve_docs(options)
+          end
+        end
+      end
+
+      def self.serve_docs(options)
+        if options['jekyll']
+          options = init_jekyll_docs(options)
+        else
+          options = init_octopress_docs(options)
+        end
+        options["serving"] = true
+        options = Jekyll.configuration Jekyll::Utils.symbolize_hash_keys(options)
+        Jekyll::Commands::Build.process(options)
+        Jekyll::Commands::Serve.process(options)
+      end
+
+      def self.init_octopress_docs(options)
+        Octopress.config({
+          'config-file' => File.join(site_dir, '_octopress.yml'),
+          'override' => { 'docs_mode' => true }
+        })
+        require_gems
+        options['source'] = site_dir
+        options['destination'] = File.join(site_dir, '_site')
+        options
+      end
+
+      def self.init_jekyll_docs(options)
+        options.delete('jekyll')
+
+        # Find local Jekyll gem path
+        #
+        spec = Gem::Specification.find_by_name("jekyll")
+        gem_path = spec.gem_dir
+
+        options['source'] = "#{gem_path}/site",
+        options['destination'] = "#{gem_path}/site/_site"
+        options
+      end
+
+      def self.site_dir
+        Docs.gem_dir('docs')
+      end
+
+      def self.require_gems
+        file = File.join(Dir.pwd, '_config.yml')
+        if File.exist? file
+          config = YAML.safe_load(File.open(file))
+          gems = config['gems']
+          if gems && gems.is_a?(Array)
+            gems.each {|g| require g }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/octopress-docs/doc.rb

@@ -0,0 +1,82 @@
+module Octopress
+  module Docs
+    class Doc
+      attr_reader :filename
+
+      def initialize(options={})
+
+        @file            = options[:file]
+        @dir             = options[:dir] ||= '.'
+        @file_dir        = File.dirname(@file)
+        @plugin_name     = options[:plugin_name]
+        @plugin_slug   ||= options[:plugin_slug] || @plugin_name
+        @plugin_type     = options[:plugin_type] || 'plugin'
+        @base_url       = options[:base_url]
+      end
+
+      # Add doc page to Jekyll pages
+      #
+      def add
+        if Octopress.config['docs_mode']
+          Octopress.site.pages << page
+        end
+      end
+
+      def disabled?
+        false
+      end
+
+      def file
+        File.basename(@file)
+      end
+
+      def info
+        "  - #{permalink.ljust(35)}"
+      end
+
+      def page
+        return @page if @page
+        @page = Octopress::Ink::Page.new(Octopress.site, @dir, page_dir, file, {'path'=>base_url})
+        @page.data['layout'] = 'docs'
+        @page.data['plugin'] = { 
+          'name' => @plugin_name, 
+          'slug' => plugin_slug,
+          'docs_base_url' => base_url
+        }
+        @page.data['dir'] = doc_dir
+        @page
+      end
+
+      private
+
+      def permalink
+        File.basename(file, ".*")
+      end
+
+      def read
+        File.open(File.join(@dir, @file)).read
+      end
+
+      def plugin_slug
+        Filters.sluggify @plugin_type == 'theme' ? 'theme' : @plugin_slug
+      end
+
+      def base_url
+        @base_url || if @plugin_type == 'theme'
+          File.join('docs', 'theme')
+        else
+          File.join('docs', 'plugins', @plugin_slug)
+        end
+      end
+
+      def page_dir
+        @file_dir == '.' ? '' : @file_dir
+      end
+
+      def doc_dir
+        File.join(@dir, page_dir, File.dirname(@file))
+      end
+
+    end
+  end
+end

data/lib/octopress-docs/tag.rb

@@ -0,0 +1,18 @@
+# For plugin authors who need to generate urls pointing to ther doc pages.
+
+module Octopress
+  module Docs
+    class DocUrlTag < Liquid::Tag
+      def initialize(tag_name, markup, tokens)
+        super
+        @url = markup.strip
+      end
+
+      def render(context)
+        '/' + File.join(context['page']['plugin']['docs_base_url'], @url)
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('doc_url', Octopress::Docs::DocUrlTag)

data/lib/octopress-docs/version.rb

@@ -0,0 +1,5 @@
+module Octopress
+  module Docs
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: octopress-docs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Mathis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: octopress
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc
+- !ruby/object:Gem::Dependency
+  name: octopress-ink
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc
+- !ruby/object:Gem::Dependency
+  name: octopress-solarized
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: octopress-escape-code
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: View docs for Octopress and its plugins
+email:
+- brandon@imathis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/octopress-docs.rb
+- lib/octopress-docs/command.rb
+- lib/octopress-docs/doc.rb
+- lib/octopress-docs/tag.rb
+- lib/octopress-docs/version.rb
+homepage: https://github.com/octopress/docs
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.1
+signing_key: 
+specification_version: 4
+summary: View docs for Octopress and its plugins
+test_files: []