jekyll-tabler 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2371d036aed4d13b02b545cb576a619a98eb740cfd76f07cd00437e1ca9b4bd2
-  data.tar.gz: c436b3ef8883931e75c2a93817780f66d6c7f3a4275890a7bc2f27561793b6a4
+  metadata.gz: 7f2f8acca77d940b511b6504685dc8d199ec3994cbc909aa5dfc87d722ea1ca3
+  data.tar.gz: bb79c09d09e5613f42d6b984023af5482181d698ae1c9c119478afc764a8496f
 SHA512:
-  metadata.gz: 8be478e87163c9c9147f312810e3e0b0b648c9b12564fe915deed2b9b70cecd571215b30f105df641b1729b9523c105f447ed09a7d7ff070f0b77d15da646168
-  data.tar.gz: 9e85e5c5e15a2fb0e2d2509c83134bc43799fb5f280fb3cd3d80c6182909f36afa5e2d85e2c7dc285b16e4734221db5d5ae847ddb9badf965595daa9a559964b
+  metadata.gz: 47ea8e92733ea94a8c108e09e383a73550d344b0b53b0a0e4c95d1b005ddbb6e8b37f4077f66dc2a91656f13e5b986104bbc377ac2f14a40b798b46e2ddb069a
+  data.tar.gz: 72161204eb80ca0f73b844b80bc2d55e977c6ac0958a96b037fafeef0adaef1f135963a02508e937ab318e506804079669aae5e57e7b84dda90ee90214180e28

data/README.md

@@ -17,6 +17,15 @@ Install the gem and add to the application's Gemfile by executing:
 bundle add jekyll-tabler
 ```
 
+In your `Gemfile`:
+
+```ruby
+group :jekyll_plugins do
+  # other jekyll plugins
+  gem 'jekyll-tabler' # add tabler plugin
+end
+```
+
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
@@ -27,43 +36,62 @@ gem install jekyll-tabler
 
 Register the plugin in your Jekyll site and render icons with the `tabler` Liquid tag:
 
-```ruby
+### Jekyll site configuration
+
+**`_config.yml`**
+
+```yaml
 plugins:
- - jekyll-tabler
+  - jekyll-tabler
 ```
 
-```liquid
-{% tabler alarm %}
-{% tabler alarm 32 %}
-{% tabler alarm 32 red %}
-{% tabler alarm size=32 %}
-{% tabler alarm color=red %}
-{% tabler alarm color=red size=32 %}
-{% assign icon_name = foo.icon %}
-{% tabler icon_name 32 red %}
-{% tabler github 32 red %}
-{% tabler page.icon_name size=page.icon_size color=page.icon_color %}
-{% tabler page.icon_name 32 page.icon_color %}
-```
+### Liquid Tags
+
+- **Outline Tag** : `{% tabler icon_name [size] [color] [size=value] [color=value] %}`
+- **Filled Tag** : `{% tabler_filled icon_name [size] [color] [size=value] [color=value] %}`
+
+### Parameters
+
+Liquid variables are supported for all arguments, including top-level names like `icon_name` or `brand-github` and dotted lookups like `page.icon_name`.Optional parameters can be passed as named arguments like `size=32` and `color=red` in any order.
+
+1. `icon_name`(Required) : Name of the [Tabler Icons](https://tabler.io/icons), must be first place after liquid tag name.
+   `icon_name` can find at search bar of <https://tabler.io/icons>.
+2. `size`(Optional) : Width and Height of SVG default to `24`.
+3. `color`(Optional) : Color of `fill` for filled SVG and `stroke` for outline SVG , default `currentColor`
+
+### Example
+
+- **Github outline icon**
+
+  With default size and color
+
+  ```liquid
+  {% tabler brand-github %}
+  ```
+
+  With custom size and color
+
+  ```liquid
+  {% tabler brand-github size=36 color=#673ab8 %}
+  ```
 
-Parameters:
+- **Github filled icon**
 
-- `icon_name` is required.
-- `size` is optional and defaults to `24`.
-- `color` is optional and defaults to `currentColor`.
-- Optional parameters can be passed as named arguments like `size=32` and `color=red` in any order.
-- `color` is optional and defaults to `currentColor`.
-- Liquid variables are supported for all arguments, including top-level names like `icon_name` or `github` and dotted lookups like `page.icon_name`.
+  With default size and color
 
-## Development
+  ```liquid
+  {% tabler_filled brand-github %}
+  ```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  With custom size and color
 
-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`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+  ```liquid
+  {% tabler_filled brand-github size=36 color=#673ab8 %}
+  ```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jekyll-tabler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-tabler/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/[USERNAME]/jekyll-tabler>. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jekyll-tabler/blob/master/CODE_OF_CONDUCT.md).
 
 ## License