jekyll-gl 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3c057ae6377c1321a169a6b536da7211ba801d6
-  data.tar.gz: 23640f722cf1365da78b9ac654a049f676e2756b
+  metadata.gz: bd1bebec56902ea7801d352ddda0306cf4c6db5a
+  data.tar.gz: b5a5d914d2749327d8c499600f2342fc19c60c90
 SHA512:
-  metadata.gz: 3a5a84405c8341a0d9600506e86f581f1db04dc4834faf8bd596fa93bb0c80b6cc1600ea661e82ab34ce2714d29a046a313754151cb26443c1b68d9f83fc10ac
-  data.tar.gz: 36d28d2988e3e9b1748d555c9ff0d84e8fc9fddf9097281eb634111a5d352bea5857bab674ee1632c663c31d64a21696609d0dd9fdea2a372182ac1ae1652853
+  metadata.gz: db34c7162d368277850b210d8e92fe44c57c49185bcab45bfd8e52c05367cc6b78c226151588562ecd3f28417a44d9d14ba3363c8721a6555378a9290dad34a9
+  data.tar.gz: 19596fc361d2885cc7e03fd231c492c1682523aecfcfacb87ca92bd9cc07b9a410d1428d2db1d5e137ee13893befc71961247f580cb752fbb5ecdd71c8b0e2f6

data/README.md

@@ -1,6 +1,6 @@
 # jekyll-gl
 
-This is a very simple Jekyll plugin to be used on Hyojun.guideline project. It'll place `.gl` class on all markdown generated elements.
+This is a very simple Jekyll plugin to be used on Hyojun.guideline project. It'll place `.gl` class on all markdown generated elements. It also creates some liquid tags for creating specific modules: `example`, `typography`, `colors` and.
 
 ## Installation
 
@@ -39,6 +39,77 @@ kramdown:
   transliterated_header_ids: true
 ```
 
+### Tags
+
+There are some liquid tags defined to be used inside the markdown files that should be used as helpers on creating the guideline:
+
+#### Example boxes
+
+To create an example box with an html inside, just wrap the code with `{% example [checkers] [dark|inline] [full] %}` tag. Ex.:
+
+* Basic example box:
+
+    ```
+    {% example %}
+    box de exemplo padrão
+    {% endexample %}
+    ```
+
+* Example box with checkers background:
+
+    ```
+    {% example checkers %}
+    box de exemplo padrão com checkers
+    {% endexample %}
+    ```
+    
+* Dark version of the checkers background:
+
+    ```
+    {% example checkers dark %}
+    box de exemplo padrão com checkers escuro
+    {% endexample %}
+    ```
+
+* Full-width example box won't be limited by the guideline default max-width:
+    ```
+    {% example full %}
+    box de exemplo full
+    {% endexample %}
+    ```
+
+* Inline example box to be used in the middle of texts for small examples:
+    ```
+    {% example inline %}
+    box de exemplo full
+    {% endexample %}
+    ```
+
+> Note that any of the options can be combined, such as `full checkers`, `inline checkers dark`, etc.
+
+### Char-tables
+
+To create a chartable, just use the `{% typography [...font-family] %}` tag with the glyph list inside, separated by `,`. Example:
+
+```
+{% typography Helvetica, sans-serif %}
+a,b,c,d,e,f,g,h,i,j,k 
+A,B,C,D,E,F,G,H,I,J,K
+{% endtypography %}
+```
+
+### Color pallete
+
+To create a color pallete, just use the `{% colors %}` tag with the colors values inside, separated by a line break. You can algo place another value to be shown to the user instead of the raw data, useful for projects that uses color variables:
+
+```
+{% colors %}
+#fefede
+rgba(10,20,10,.5)
+rgba(10,20,10,.3);$var-name
+{% endcolors %}
+```
+
 ## Contributing
 
 Go to [Hyojun.guideline](https://bitbucket.org/fbiz/hyojun.guideline/) for more information.

data/jekyll-gl.gemspec

@@ -4,11 +4,11 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-gl"
-  spec.version       = "0.1.2"
+  spec.version       = "0.1.3"
   spec.authors       = ["Marcelo Miranda Carneiro"]
   spec.email         = ["mcarneiro@fbiz.com.br"]
   spec.summary       = %q{Hyojun.guideline Jekyll Plugin}
-  spec.description   = %q{This Jekyll plugin will place a ".gl" class in every mardown generated elment to automate Hyojun.guideline.}
+  spec.description   = %q{This Jekyll plugin will place a ".gl" class in every mardown generated elment to automate Hyojun.guideline. Also, creates some liquid tags for the markdown files.}
   spec.homepage      = "http://fbiz.bitbucket.org/hyojun.guideline/"
   spec.license       = "MIT"
 

data/lib/jekyll-gl.rb

@@ -87,5 +87,58 @@ module Jekyll
   end
 end
 
+module Jekyll
+  class Typography < Liquid::Block
+
+    def initialize(tag_name, markup, options)
+      super
+
+      @font_family = markup
+    end
+
+    def render(context)
+      content = ''
+
+      super.split(/[,\n]/).each do |val|
+        next if val == ''
+        content += '<li title="{{glyph}}"> {{glyph}} </li>'.gsub('{{glyph}}', val);
+      end
+
+      '<ul class="gl-char-table" style="font-family: {{family}};">{{content}}</ul>'
+        .gsub('{{family}}', @font_family)
+        .sub('{{content}}', content)
+    end
+  end
+end
+
+module Jekyll
+  class Colors < Liquid::Block
+
+    def initialize(tag_name, markup, options)
+      super
+
+      @font_family = markup
+    end
+
+    def render(context)
+      content = ''
+
+      super.split(/[\n]/).each do |val|
+        next if val == ''
+
+        data = (val && val.split(';')) || [];
+        content += '<li title="{{var}}" style="background-color:{{color}};"></li>'
+          .sub('{{var}}', data[1] || data[0] || '')
+          .gsub('{{color}}', data[0] || '');
+      end
+
+      '<ul class="gl-colors">{{content}}</ul>'
+        .sub('{{content}}', content)
+    end
+  end
+end
+
 Liquid::Template.register_tag('example', Jekyll::Example)
+Liquid::Template.register_tag('typography', Jekyll::Typography)
+Liquid::Template.register_tag('colors', Jekyll::Colors)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-gl
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Marcelo Miranda Carneiro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,7 +25,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.7'
 description: This Jekyll plugin will place a ".gl" class in every mardown generated
-  elment to automate Hyojun.guideline.
+  elment to automate Hyojun.guideline. Also, creates some liquid tags for the markdown
+  files.
 email:
 - mcarneiro@fbiz.com.br
 executables: []