jekyll-liquid-debug 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1109cf5a8b8b59ad63c3b67306271b5869d00bbd42ce493cd5e1acf8b80129ee
-  data.tar.gz: 0ea7545d75b22f72836a2f30ad7c860ab2523caea96cec7c423223165fead59f
+  metadata.gz: 1e17e174844777be1c2b1ceb65a7a26fbb6ba8c78d1b4efcde01b32f81385937
+  data.tar.gz: 4ee1f8f6ff148b8a7dc6b33d5ca96654e5bb0fc49bdbe4723ff890c799c68c08
 SHA512:
-  metadata.gz: b88284680b4f74b5385d431464cd7fca10a988fdf5c5365f1a68d6d41f6ce240075cf97f782b014e0714f89c68e100cc9710178d1ef248df0f8f0576c33f439f
-  data.tar.gz: 7afff85a938255f81e48a3c26d9a046a88ca5de74eb1f2bce1fd83fa04f3e9b6f686fa8ee3935354381b845f16d51ba26d26e3ffba5313c95db852d900dfdd2f
+  metadata.gz: 9a016d74533b67ab881c63cf6f160028003d44f51f48539fd20a4fbd4271604fefc74d39734306ddfbeff6529dfc6b79068e6943b06588d36e73612725296dc9
+  data.tar.gz: 86809db7617ff55ed4e69eb2e046761612b986fb26b7f11deb91adb9ed9158697192df1ec8c529b73412fb85a68968799d2f09c7b6f67d76f9b6f4d400703906

data/README.md

@@ -0,0 +1,163 @@
+# Jekyll Liquid Debug
+
+This program is created to **debug** [`shopify-liquid-template`](https://shopify.github.io/liquid/), which is a type of programing language mainly used to generate static website, especially for [`Jekyll`](https://jekyllrb.com/).
+
+
+## Installation
+
+To install, execute,
+
+```ruby
+gem install 'jekyll-liquid-debug'
+```
+
+
+## Reason of Creation
+
+Jekyll is an awesome static website generator, it uses `liquid` for coding. However, `liquid` works like a **black-box**, it is not command-line-aware, all those magic things are happening in the backend.
+
+Many time, we just want to see through what is happening of a single line or a very small piece of snippets, like for many interpreting languages, `print debug-info`. However, `liquid` does not allow us to do this.
+
+Thus, every time we have to **build & debug** the whole site again and again. It is way too time consuming, and also needing great patiences and efforts. This, definitely, is not what we expected.
+
+So, it comes to this package.
+
+With it, you can simply run your `liquid` file in your terminal, to help check either semantic or functioning errors.
+
+
+## Usage
+
+After you successfully installed, show help message,
+
+```
+jekyll-liquid-debug -h
+```
+
+The options in **Input files** will look like,
+
+```
+-f, --file [FILE]                input liquid template
+-t, --html [FILE]                input html template
+-k, --md [FILE]                  input raw markdown file, precedent for option `-t'
+    --out-html                   output html file, overwrite may happen
+    --out-md                     output markdown file, overwrite may happen
+```
+
+They are self-explanation.
+
+
+## Examples
+
+### Write out default markdown file
+
+To help developments, a **default** markdown file is created. This file includes all the `Markdown syntax`s used to convert **HTML** file, and to boost debugging, each of those **Text Formatting** is repeated in three times.
+
+To have a look of this file, run
+
+```
+jekyll-liquid-debug --out-md
+```
+
+
+### Debug Liquid Template
+
+If you have a `liquid` coded file, `myfile.liquid`
+
+```
+{%- assign my_variable = false -%}
+{%- assign my_number = 10 -%}
+{%- if my_variable == true -%}
+    {{ my_number | plus: 1 }}
+{%- else -%}
+    {{ my_number | minus: 1 }}
+{%- endif -%}
+
+{{}}
+Debug my_number: {{ my_number }}
+```
+
+You want to printout `my_number`, you can run,
+
+```
+jekyll-liquid-debug -f myfile.liquid
+```
+
+Then you will see,
+
+```
+Note: using default markdown file < jekyll-markdown.md >
+9
+Debug my_number: 10
+```
+
+**Note:** empty command `{{}}` in `liquid` works like starting a new line. For more, please refer to [`shopify-liquid-template`](https://shopify.github.io/liquid/). It's mainly used to _separate_ the debug info and other leading messages from white-space-controlling. Otherwise, your debug info may be printed out at the same line.
+
+I also have a post about the [`liquid-white-space-control`](https://zhongxiang117.github.io/Jekyll/Things-Need-To-Know/liquid-whitespace.html)
+
+
+### Debug Liquid Template With Raw Markdown As Input
+
+So what will happen if you want to code a `liquid` with the `Markdown` file?
+
+The answer is you can use it as the input.
+
+Please be aware of that, the `Markdown` file you input will be converted to `html` file at background in first, then the new variable `content` will be generated, which you can invoke inside the `liquid`.
+
+
+For example you have a `Markdown` file, which is under a name `myMarkdown.md`,
+
+```
+Good good **study**, day day **up**.
+
+Add oil!
+
+Today is a good day, people mountain people sea.
+
+Know is **know**, noknow is noknow.
+```
+
+If you want to remove the `<strong></strong>` tag for words `study` & `up` & `know` after they are converted to `THML`, you can do this, inside your `myfile.liquid`, using **filter** simply `replace` those tags to be empty.
+
+```
+{{ content | replace: "<strong>", "" | replace: "</strong>", "" }}
+```
+
+Run,
+
+```
+jekyll-liquid-debug -f myfile.liquid -m myMarkdown.md
+```
+
+**Note:** you can also only convert your raw `Markdown` to `HTML`, by using `jekyll-liquid-debug -m myMarkdown.md --out-html`.
+
+
+### Debug Liquid Template With HTML As Input
+
+It works similar like using `Markdown` as the input, with the changing of option,
+
+```
+jekyll-liquid-debug -f myfile.liquid -t myHTML.html
+```
+
+**Warning:** When both `-t` & `-m` are specified, only your Markdown file for `-m` will be parsed into `liquid` as the variable `content`.
+
+
+### Show Development Feature
+
+```
+jekyll-liquid-debug --feature
+```
+
+
+## Dependency
+
+```
+gem install liquid
+gem install kramdown
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zhongxiang117/jekyll-liquid-debug.
+

data/jekyll-liquid-debug.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.summary       = "Light Weight Jekyll Liquid Template Debug Package"
   s.license       = "MIT"
   s.homepage      = "https://github.com/zhongxiang117/jekyll-liquid-debug"
-  s.files         = Dir["bin/*","data/*","lib/**/*", "jekyll-liquid-debug.gemspec", "LICENSE"]
+  s.files         = Dir["bin/*","data/*","lib/**/*", "jekyll-liquid-debug.gemspec", "LICENSE","README.md"]
   s.require_paths = ["lib"]
 
   s.add_dependency("liquid", "~> 4.0.0")

data/lib/jekyll-liquid-debug/version.rb

@@ -1,8 +1,9 @@
-VERSION = '0.2.2'
+VERSION = '0.2.3'
 
 FEATURE = [
   '* Version 0.1.0: Ruby-liquid Debug',
   '* Version 0.2.0: Add Kramdown conversion',
   '* Version 0.2.1: Change args type from Struct to Hash',
   '* Version 0.2.2: Optimize the combination of options',
+  '* Version 0.2.3: Add README.md',
 ]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-liquid-debug
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Xiang Zhong
@@ -46,6 +46,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - bin/console
 - bin/jekyll-liquid-debug
 - bin/setup