console-theme 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afd6f0036e17167e1df58166084721c79806acee
-  data.tar.gz: f0fba993386f85af42572c85ac416861d6631bcb
+  metadata.gz: 3c87dbf2d8441690db6d6d9fce9bb71564814404
+  data.tar.gz: e22275841b1b599d5c59809e782f63dbf64a0f48
 SHA512:
-  metadata.gz: de5681ca9240d262ee3a5be3f146252045ab7056360012a8745b2ecb2189592fe7f6fbe206538d601224416b72e0ebd90f185eddd782e3c25656da8e4e38679b
-  data.tar.gz: 38a0e4037c9b2bb007f03723269cc279cf65899a33773d715600256d7bee4f03c383223cb40c9a9db2ff36483ba92e363e609a5293edb04c722b370d585b0cc5
+  metadata.gz: 5f11c0d27ce7e22c1bab3648d17f4afb83666a5ef6c82842232534b7e6f9395ca43e65f16b63b0857fb8b15cb70a2a2fd3d133bcf5646d5e55400d72586d6b5b
+  data.tar.gz: ecc7b7087a332c46c7ac36baf9d32f9cb215c5b063279185d9fdb6c8790f5e13603909d2d93f61e98060c168299a1a9edf3a7c3a487b56692d4b06b05f8bf97f

data/README.md

@@ -24,6 +24,25 @@ The primary features of this theme are:
 
 There are more features to come. Stay tuned!
 
+# Table of Contents
+
+* [Installation](#installation)
+  * [Gulp Settings](#gulp-settings)
+  * [Using a BrowserSync instead of Jekyll generated local server](#why-browsersync)
+* [Usage](#usage)
+  * [Creating a post](#create-post)
+  * [Integrating Disqus with your website](#integrate-disqus)
+  * [Using svg symbol](#use-svg-symbol)
+  * [Adding more languages](#add-languages)
+* [Categorization](#categorization)
+* [Layouts and Blocks](#layout-block)
+* [Stylesheets](#stylesheets)
+* [Why some pages need to use folder structure](#why-use-folder-structure)
+* [Contributing](#contributing)
+* [Development](#development)
+* [License](#license)
+
+<div id='installation'></div>
 ## Installation
 
 Add this line to your Jekyll site's Gemfile:
@@ -46,6 +65,7 @@ Or install it yourself as:
 
     $ gem install console-theme
 
+<div id='gulp-settings'></div>
 ### Gulp settings
 
 To be able to use Gulp, you will need to install Node.js as well as its package manager (i.e. npm). Once you have installed npm. Go to the folder where the package.json is located and run `npm install` and it will install all the dependencies including Gulp.
@@ -60,6 +80,7 @@ This task would run several other tasks defined in `gulpfile.js.` To run individ
 
     $ gulp minify-css
 
+<div id='why-browsersync'></div>
 ### Using a BrowserSync instead of Jekyll generated local server.
 
 When running Jekyll serve, it is possible to run a server. However, I chose to use BrowserSync instead of that for few reasons:
@@ -69,8 +90,10 @@ When running Jekyll serve, it is possible to run a server. However, I chose to u
 
 Therefore, please do use gulp!
 
+<div id='usage'></div>
 ## Usage
 
+<div id='create-post'></div>
 ### Creating a post
 
 Please use `rake` command to create a post. Using this command would automatically generate Jekyll front matter with a unique Disqus identifier. The syntax for rake command is [assuming that you are in the root folder]:
@@ -81,6 +104,7 @@ rake post title="Title" [date="2017-01-13"] [category="category"]
 
 [] are optionals.
 
+<div id='integrate-disqus'></div>
 ### Integrating Disqus with your website.
 
 You will need to first have Disqus account. Once the account is ready, please modify `config.yml` file by adding your shortname for disqus like below:
@@ -91,7 +115,8 @@ disqus_shortname: [your short name. Remove the bracket!]
 
 By doing this, every disqus script would use that information and disqus identifier to fetch relevant data.
 
-### How to use svg symbol
+<div id='use-svg-symbol'></div>
+### Using svg symbol
 
 Using svg symbol is a good practice. By doing this, we can organize svgs better while not losing the caching functionality. Make sure you change your svg file to the file that conforms to the svg symbol style:
 
@@ -117,12 +142,31 @@ This would display beaker on the screen! Examples are available.
 
 This external svg file is located in: `assets/css/images/graphics/svg-symbols.svg`
 
+<div id='add-languages'></div>
+### Adding more languages
+
+This theme uses `jekyll-polyglot` plugin with the plugin I developed. I have already initiated the internationalization work. The partially translated languages are: English, German and Korean. To add languages, simply add the language acronym (e.g. German is de ('Deutsch') but really you can define your own acronym) to languages variable in `_config.yml` (e.g. `languages: ["en", "de", "ko"]`). To add more languages, you would need to do the following:
+
+1. **`localization.json`**: this is a nested json object file. The key represents the id for each translation and the value would have another key-value object with its key repesenting language acronym and the value being the translated word.
+
+2. **`search.js`**: this may later be integrated with `localization.json` file but at the moment it is separate. In this js file, you will see `populateJSON()` function. The translation json in this function will be used in search.html. To add more languages, you need to modify this function.
+
+The above files will then be used by the plugin called **Localization** (i.e. `_plugins/localize.rb`) and to use this simply:
+
+```liquid
+{% localize [key_id] %}
+```
+
+Explore the files and you will see plenty of examples. The plugin will automatically detect the language currently being used and then translate the word according to the one defined in `localization.json`.
+
+<div id='categorization'></div>
 ## Categorization
 
 This theme uses data-driven categorization, which makes the construction of categoization simple and succinct. The json file for category is located in _data/categories.json. Each category has three attributes: title, href and id (used to uniquely identify them). Please view the sample file to get a sense of it.
 
 To create the category pages, you need to create a 'category' folder and subfolders would be the name of categories. They can be further nested (i.e. sub categories). Each folder would have index.md (as we will be using folder structure for creating the page for category.) You can reference my website or refer to the examples provided.
 
+<div id='layout-block'></div>
 ## Layouts and Blocks
 
 This theme values simplicity. As such, every layout would look extremely analogous with each other. However, for extensibility there are about 7 layouts:
@@ -148,6 +192,7 @@ These layouts share same blocks, which are defined in _includes folder. There ar
 * **not_found**: for 404 page.
 * **search**: the block for search.
 
+<div id='stylesheets'></div>
 ## Stylesheets
 
 Jekyll uses sass, which is a scripting language that would be interpreted into css files. They are largely divided into three usages:
@@ -158,14 +203,17 @@ Jekyll uses sass, which is a scripting language that would be interpreted into c
 
 Based on your needs, you may modify these files.
 
+<div id='why-use-folder-structure'></div>
 ## Why some pages need to use folder structure
 
 To create a page, there are few ways to achieve it. One of the solutions would be to use folder structure. For example, if we were to create a page called 'archive', then you can create the folder called 'archive' and then include index.html.  For pages that use jekyll-paginate functionality, it is mandatory to use this. Otherwise, the functionality would not work. Please do not use .md extension. Use `.html` only as it would not work if this extension is not used.
 
+<div id='contributing'></div>
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jaehee0113/console. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
+<div id='development'></div>
 ## Development
 
 To set up your environment to develop this theme, run `bundle install`.
@@ -174,6 +222,7 @@ Your theme is setup just like a normal Jekyll site! To test your theme, run `bun
 
 When your theme is released, only the files in `_layouts`, `_includes`, and `_sass` tracked with Git will be released.
 
+<div id='license'></div>
 ## License
 
 The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/_includes/search.html

@@ -6,9 +6,9 @@
       <label class="container-search-inner-label" for="search-box">{% localize search %}</label>
     {% endif %}
     {% if site.active_lang == 'en' %}
-      <form class="container-search-inner-form" id="search-form" action="{{site.production_url}}/search/" method="get">
+      <form class="container-search-inner-form" id="search-form" action="{{site.production_url}}/search" method="get">
     {% else %}
-      <form class="container-search-inner-form" id="search-form" action="{{site.production_url}}/{{site.active_lang}}/search/" method="get">
+      <form class="container-search-inner-form" id="search-form" action="{{site.production_url}}/{{site.active_lang}}/search" method="get">
     {% endif %}
       <div class="container-search-inner-form-input">
         <input type="text" placeholder="{% localize lookformore %}" class="container-search-inner-form-box" id="search-box" name="query">

data/assets/js/search.js

@@ -120,7 +120,8 @@ jQuery(document).ready(function(){
   function initSearchResults() {
 
     if(resultArray === null){
-      searchResults.innerHTML = '<div class=\"post-list-input-required\"><svg class=\"icon-warning\"><use xlink:href=\"/assets/images/graphics/svg-symbols.svg\#warning"></use></svg><li class="ask-input">' + getJSON("input_needed", currLang) + '<blink>_</blink> </li></div>';
+      if(searchResults != null)
+        searchResults.innerHTML = '<div class=\"post-list-input-required\"><svg class=\"icon-warning\"><use xlink:href=\"/assets/images/graphics/svg-symbols.svg\#warning"></use></svg><li class="ask-input">' + getJSON("input_needed", currLang) + '<blink>_</blink> </li></div>';
       return;
     }
     

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: console-theme
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jae Hee Lee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,6 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: jekyll-polyglot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.4
+- !ruby/object:Gem::Dependency
+  name: jekyll-seo-tag
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: jekyll-paginate
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: jekyll-feed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 description: 
 email:
 - jaeheelee0113@gmail.com