middleman-page-toc 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 855385c433027c349a89cf3fbeef7e0ce72dff6c
-  data.tar.gz: d05ab6780cd6e06096c5158cb357d1bf4d2343ee
+  metadata.gz: 52b280eb1abcbff30987b7390232d3548d51f3a6
+  data.tar.gz: 1dcb3ea819d1ac7a8ad89cfe76ccef6e04866c2b
 SHA512:
-  metadata.gz: 65841d01670d523d08113e1b8e3b57de7c9c6b61888ae773be89a5f9232a59d94686af31757aaa4d6a005bc61a8135e62997bb0e20680f1f96d71bd163d9f85c
-  data.tar.gz: 917c167166a6ee536091af4a485db4a51b74f2c22bd14c6d2677092754dddfb7250784595609b982a6ec4734d876d34643a5349d1fe026c195522c4a46c89a37
+  metadata.gz: 1fb8a8fa38e465be341f09cca35dbdcce0e55b511adc134b9fb74e6f1800e66d5e9522e955c25cb85263b21bd614d1cba7ae224e95f4e20e0fd89ab575886b37
+  data.tar.gz: 3fea0fa4b6d6e76fe77245c4b46e8acd36e6792fb6cb29d2c39b1af344bc97f6c47d489fdab2d289a5c3dac4bf53ff4eb6656a2fc0a3b922a079d655c7c4f4b1

data/README.md

@@ -1,8 +1,6 @@
 # middleman-page-toc
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/middleman`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+An extension to Middleman which provides a helper method to render table of contents of the specified page/resource.
 
 ## Installation
 
@@ -20,19 +18,37 @@ Or install it yourself as:
 
     $ gem install middleman-page-toc
 
+## Settings
+
+Use **redcarpet** as markdown engine and enable :toc_data option. and then activate this extension:
+
+```ruby
+set :markdown_engine, :redcarpet
+set :markdown, :fenced_code_blocks => true, :autolink => true,
+  :smartypants => true, :tables => true, :with_toc_data => true
+
+activate :page_toc
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+use **render_toc(page, options)** helper function on your layout or page.
+
+```ruby
+<%= render_toc(current_page) %>
+```
 
-## Development
+### options
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+- :use_collapsing
+- :button_caption
+- :expand
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+You must setup **twitter-bootstrap** css/js on your environment to use collapsing.
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/middleman/fork )
+1. Fork it ( https://github.com/atarukoddaka/middleman-page-toc/fork )
 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`)

data/lib/middleman-page-toc/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module PageToc
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/middleman_extension.rb

@@ -1,2 +1,2 @@
-require 'middleman-aks'
+require 'middleman-page-toc'
 

data/middleman-page-toc.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Write a short summary, because Rubygems requires one.}
   spec.description   = %q{Write a longer description or delete this line.}
-  spec.homepage      = "http://atarukodaka.github.com/middleman-page-toc"
+  spec.homepage      = "http://github.com/atarukodaka/middleman-page-toc"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ["lib"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-page-toc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ataru Kodaka
@@ -68,7 +68,7 @@ files:
 - lib/middleman-page-toc/version.rb
 - lib/middleman_extension.rb
 - middleman-page-toc.gemspec
-homepage: http://atarukodaka.github.com/middleman-page-toc
+homepage: http://github.com/atarukodaka/middleman-page-toc
 licenses:
 - MIT
 metadata: {}