jekyll-code-example-tag 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc6b3dbb5ed6465f5d964a2f14f42ee6024337a2
-  data.tar.gz: 92deaf1d6c1133049877ea597c0c6fe28a0d67c9
+  metadata.gz: 3d2568731b120b0d05ce63de4c9eb9b5491359bf
+  data.tar.gz: e79cee683707cfa4fb444d8ba24d15516406e3d3
 SHA512:
-  metadata.gz: 0c8f4f1d2cd4464713302dddb000755e6b32e14e86e38563cc64a7138a39102b3597b8b193544f5d253594b14edf049bda29002243070a976d87f6c7cca827cf
-  data.tar.gz: fcae7f05e3ada2e1564c13adefd5b49dcc420fe0b8dad4a9c5de007146088cd753e31b98fb2c6bcd508aae644bcacd586ccd293d020e1a8be49eda861967a8b9
+  metadata.gz: c6fce169023e9390a079856ee410830e61cdf68d1a0684a0cff2d550d477bddcff1c45241ffce919d830f851389f0881961fcb094579845bbdb3cc6af2ba1937
+  data.tar.gz: fdf58c54050e0b968b7e46a53862114188c9d0525b56b896b05fe28162f3c9e3572f9597d2f1cb1ec9d448d5fc1ad1aadcc703246571ee5e394a59373fd261c0

data/README.md

@@ -1 +1,122 @@
-Stuff!
+jekyll-code-example-tag
+=======================
+
+Provides a tag that allows you to include in your posts and pages code examples
+for multiple langagues that are kept in seperate files. Another tag allows you
+to combine all code examples that are on a page.
+
+## Installation
+
+Add the following to your application's Gemfile:
+
+    gem 'jekyll-code-example-tag'
+
+and then execute:
+
+    bundle install
+
+Or install it manually:
+
+    gem install jekyll-code-example-tag
+
+## Usage
+
+### code_example
+
+First, select a folder to place your code examples in. By default, the top
+level folder `code_examples` will be used. If you would like to store your
+examples in a different folder, than create and set a `code_example_dir`
+setting in your _config.yaml:
+
+    code_example_dir: assets/code/examples
+
+Now, add some code examples. Create folders for each language you would like to
+provide a code example for. Then, add files to each language folder that 
+contain language appropriate code examples.
+
+For example, say we would like to include some Hello World examples in Ruby and
+Python. First, assuming we are using the default code examples directory, we
+would add the following to your project:
+
+    .
+    |-code_examples
+      |-ruby
+        |-hello_world
+      |-python
+        |-hello_world
+
+`ruby/hello_world` could contain
+
+    puts "Hello World"
+
+while `python/hello_world` could contain
+
+    print "Hello World"
+
+Now, create a post that includes these code examples. Include a code example in
+a page or posting with the *code_example* tag:
+
+    ---
+    title: Starting to Program
+    ---
+
+    Here is everybody's favorite first program, in Ruby and Python.
+
+    {% code_example hello_world %}
+
+Build your site, and you will find a page that contains the following markup:
+
+    <p>Here is everybody's favorite first program, in Ruby and Python.</p>
+
+    <div class="code-examples">            
+      <div class="buttons examples">
+        <ul>
+          <li><a href="#" class="button active" target="Python">Python</a></li>
+          <li><a href="#" class="button" target="ruby">Ruby</a></li>
+        </ul>
+      </div>
+      <div class="highlight example python" style="display: block;">
+        <pre><code class="language-python" data-lang="python">print "Hello World"</code></pre>
+      </div>
+      <div class="highlight example ruby" style="display: none;">
+            <pre><code class="language-ruby" data-lang="ruby">puts "Hello World"</code></pre>
+      </div>
+    </div>
+
+The *code_example* tag will search the folders in your code examples directory
+for files that match whatever string is given to it, and will include only
+languages/files that match it. Thus, if you add a `goodbye_world` example in
+just Ruby:
+
+    .
+    |-code_examples
+      |-ruby
+        |-goodbye_world
+        |-hello_world
+      |-python
+        |-hello_world
+
+and include it in a post:
+
+    {% code_example goodbye_world %}
+
+the resulting markup will include just the Ruby example:
+
+    <div class="code-examples">            
+      <div class="buttons examples">
+        <ul>
+          <li><a href="#" class="button" target="ruby">Ruby</a></li>
+        </ul>
+      </div>
+      <div class="highlight example ruby" style="display: none;">
+            <pre><code class="language-ruby" data-lang="ruby">puts "Goodbye World"</code></pre>
+      </div>
+    </div>
+
+### all_page_code_examples
+
+If you have included a few code examples on a page via the *code_example* tag,
+you can provide your readers with an easy to copy version of all of your
+examples by using the *all_page_code_examples* tag:
+
+    {% all_page_code_examples %}

data/jekyll-code-example-tag.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
   s.name        = 'jekyll-code-example-tag'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.date        = '2015-02-03'
   s.authors     = ['GovDelivery']
   s.email       = 'support@govdelivery.com'
-  s.homepage    = 'http://govdelivery.com'
+  s.homepage    = 'https://github.com/govdelivery/jekyll-code-example-tag'
   s.license     = 'BSD-3-Clause'
   s.summary     = 'Tags for including code examples in posts and pages.'
   s.description = %q{Provides a tag that allows you to include in your posts 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-code-example-tag
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - GovDelivery
@@ -37,7 +37,7 @@ files:
 - README.md
 - jekyll-code-example-tag.gemspec
 - lib/jekyll-code-example-tag.rb
-homepage: http://govdelivery.com
+homepage: https://github.com/govdelivery/jekyll-code-example-tag
 licenses:
 - BSD-3-Clause
 metadata: {}