jekyll-simple-template 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 215e730cc664f058fbed3f17324ff9ecb2aec82c
-  data.tar.gz: 9248f0f0040855c3abaead368159ae141c69e387
+SHA256:
+  metadata.gz: 1f68570fff91f2efaedc0c342a6e1d5bb0ad0e6eb2c9ea5dff02abd04e3518d5
+  data.tar.gz: 4489bf6ca2aefe19f76fa572615c6162b434fc9ad10e983953cd2cf7355e7912
 SHA512:
-  metadata.gz: 92f0d031a8157698f4ca20f6cdcb3ad8609a61d164cdb0a46b6865fee40b42ff2549264ba1c41e13a20c980cdfeecf907a3079843a8da413262539a93c097907
-  data.tar.gz: 6d480116321530fe0e4bec2825e6cb66fda7135bb8f244a53f825194a5999604f7edbec7e49662b387640fe81855a97ae60b023a4e140ea88313a8626132cd81
+  metadata.gz: 24efff0e53bf4d26023f4cbdb3102b21352f7ae33ae443185463d711283b9c6d9b1eaf5655b5d605b067a22a340b99b2fb87406735c51d7f007d218d77082af5
+  data.tar.gz: 90cec640b72c2d11e4ae892b291c598e5b961726ce7a23093c5bf182742231f64c0ebf03edbd77419b195d434d88e93e5629869716c82a7cfe988c098506427a

data/README.md

@@ -0,0 +1,132 @@
+# Simple Template - Jekyll
+
+[![Gem
+Version](https://badge.fury.io/rb/jekyll-simple-template.svg)](https://badge.fury.io/rb/jekyll-simple-template)
+[![Pipeline
+Status](https://gitlab.com/simple-template/jekyll/badges/master/build.svg)](https://gitlab.com/simple-template/jekyll/pipelines)
+[![Build
+Status](https://travis-ci.org/simple-template/jekyll.svg?branch=master)](https://travis-ci.org/simple-template/jekyll)
+
+Demo:  https://simple-template.gitlab.io/jekyll/
+
+This is [Jekyll](https://jekyllrb.com/) Version of [Simple
+Template](https://simple-template.gitlab.io/). The template is designed to look
+and stay minimal for the viewer but at the same time be fully featured for the
+author. The template use the fact that barebone *HTML* is already responsive,
+and hence, no *CSS* Framework is used at all. In fact for styling there is not
+even a *CSS* file, the necesarry *CSS* is embedded into *HTML* itself, to
+reduce the number of *HTTP* requests.
+
+## Plugins
+
+Instead of inventing the wheel, I used the following popular plugins for Jekyll,
+to add features to the template:
+
+* [jekyll-archives](https://github.com/jekyll/jekyll-archives): Generates
+  Archive pages for Year, Month, Day, Tags and Categories
+* [jekyll-feed](https://github.com/jekyll/jekyll-feed): Generates the Atom (RSS
+  like) Feed for Blog Posts
+* [jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag): Adds necesarry
+  SEO information in the head tag
+* [jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap): Generates
+  sitemap.org compliant sitemap for the website
+
+## Usage
+
+The template is available as Ruby
+[Gem](https://rubygems.org/gems/jekyll-simple-template/). To add the Gem to the
+website do the following:
+
+* Add the Gem in the `Gemfile`.
+
+```
+source "https://rubygems.org"
+"jekyll-simple-template"
+```
+
+* Add the Theme in `_config.yml`.
+
+```
+theme: jekyll-simple-template
+```
+
+## Configuration
+
+The template excepts following variables in the `_config.yml`.
+
+* `lang`: Langauge of the Website (for html tag)
+* `title`: Title of the Website (for SEO and Header)
+* `author`: Author of the Website (for SEO and Footer)
+* `url`: Url of the website (for SEO)
+* `baseurl` [Optional]: Baseurl of the Website (for relative URL)
+* `logo`: Logo of the Website (for SEO)
+
+[Example](https://github.com/simple-template/jekyll/blob/master/_config.yml)
+
+### Navigation
+
+For navigation links, the template looks for `_data/navigation.yml` file. The
+links should be added to the file in following format.
+
+```
+- title: "Link Name"
+  url: "http://example.com"
+```
+
+**Note**: `url` can be external or relative.
+
+[Example](https://github.com/simple-template/jekyll/blob/master/_data/navigation.yml)
+
+### Social Links
+
+For social links in footer, the template looks for `_data/social.yml` file.
+Following is the supported social networks and format in which it should be
+added.
+
+```
+facebook : username
+twitter  : username
+github   : username
+youtube  : channel
+instagram: username
+linkedin : username
+```
+
+[Example](https://github.com/simple-template/jekyll/blob/master/_data/social.yml)
+
+### SEO
+
+As mentioned above, the template uses
+[jekyll-seo-tag](https://github.com/jekyll/jekyll-seo-tag/) for adding SEO
+information. All the options from that can be used. For more information read
+its [Usage](https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/usage.md).
+
+## Sitemap and Feed
+
+As mentioned above, the template uses
+[jekyll-sitemap](https://github.com/jekyll/jekyll-sitemap/) and
+[jekyll-feed](https://github.com/jekyll/jekyll-feed) for sitemap and feed
+respectively. By default sitemap is available at `/sitemap.xml` and feed of
+posts is available at `/feed.xml`. For more information about the plugins, check
+out there repositories and read the documentations.
+
+## Layouts
+
+The template provides following layouts:
+
+* `default`: The default layout
+* `home`: For Homepage
+* `blog`: For Blog page
+* `page`: For Page
+* `post`: For post
+* `archive`: For Year, Month, Day and Tag archives
+* `redirect`: For redirection pages
+
+To override any of the built-in layouts, just create the file with same name in
+`_layouts/` directory.
+
+## License
+
+The template is Open Sourced and is Licensed under [BSD
+3-Clause](https://github.com/simple-template/jekyll/blob/master/LICENSE)
+License.

data/_includes/footer.html

@@ -23,6 +23,6 @@
 	</nav>
 	{%- endif %}
 	<p>
-		{{site.time | date :'%Y'}} &copy; {{site.author}}
+		{{site.time | date :'%Y'}} &copy; {{site.author | default: "Author"}}
 	</p>
 </footer>

data/_includes/header.html

@@ -1,5 +1,5 @@
 <header>
-	<h1>{{site.title}}</h1>
+	<h1>{{site.title | default: "Title"}}</h1>
 	{%- if site.data.navigation %}
 	<nav>
 		{%- for each in site.data.navigation %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-simple-template
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Ankit R Gadiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- README.md
 - _includes/footer.html
 - _includes/head.html
 - _includes/header.html
@@ -134,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A very simple and minimal but fully functional template