Merge pull request #11 from manid2/docfix-10, fixes #10

Documentation fixes and enhancements, fixes #10

README.md

@@ -1,43 +1,57 @@
-# [Lone Wolf Theme Jekyll](https://github.com/manid2/lone-wolf-theme/)
+# [Lone Wolf Theme Jekyll][1]
 
 [![LICENSE](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/manid2/lone-wolf-theme/blob/master/LICENSE)
 [![Jekyll](https://img.shields.io/badge/jekyll-%3E%3D%203.8-blue.svg)][jekyll]
 [![Ruby gem](https://badge.fury.io/rb/lone-wolf-theme.svg)](https://rubygems.org/gems/lone-wolf-theme/)
 
-## Introduction
+A simple [bootstrap][bs4] based jekyll theme.
 
-Simple, elegant and efficient website theme for solo freelancers.
-AKA **lone wolves** who strive to run a business single handedly.
-It is for [Jekyll][jekyll] static site generator and uses [Bootstrap 4][bs4] with beautiful [Bootswatch][bootswatch] themes.
+It uses
 
-## Who uses it
+- [github-pages compatible gems][gh-gems]
+- [bootswatch wrappers][bootswatch]
+- [animate.css][ani-css].
 
-### As of now
+## Who uses it
 
-- Lone wolf theme [docs][lwt-docs]
-- Me, [manid2][manid2]
+- [Lone wolf theme docs][1]
+- [Me, manid2][2]
 
 ## Installation
 
 ### Using remote theme
 
-Easiest way to use the theme if you dont want to make changes to the theme's code
+Easiest way to use the theme if you dont want to make changes to the theme's
+code.
 
-Add `remote_theme : "manid2/lone-wolf-theme"` to your `_config.yml` file.
+- Add `remote_theme    : "manid2/lone-wolf-theme"` to your `_config.yml` file.
 
 ### By forking the theme repository
 
-If you want to make changes to the code and to truly own the site. Follow the blog on smashing magazine to learn about this method [here](https://www.smashingmagazine.com/2014/08/build-blog-jekyll-github-pages/).
+If you want to make changes to the code and to truly own the site.
+Follow the blog on [smashing magazine][sm-gh-pages] to learn about this method.
 
 ### As a ruby gem
 
-When you want to host the site on any server other than the github pages and also to make use of plenty of jekyll plugins.
-Add `gem "lone-wolf-theme"` to your `Gemfile`.
-Update bundled gems by using `bundle` command.
-Add `theme                    : "lone-wolf-theme"` to your `_config.yml`.
+When you want to host the site on any server other than the github pages
+and also to make use of plenty of jekyll plugins.
+
+- Add `gem "lone-wolf-theme"` to your `Gemfile`.
+- Update bundled gems by using `bundle` command.
+- Add `theme    : "lone-wolf-theme"` to your `_config.yml`.
 
+## Contribution
+
+Use the link to learn how to [contribute][3] to LWT.
+
+<!-- Links in the post -->
 [jekyll]: https://jekyllrb.com/
 [bs4]: https://getbootstrap.com/
 [bootswatch]: https://bootswatch.com/
-[manid2]: https://manid2.github.io/
-[lwt-docs]: https://manid2.github.io/lone-wolf-theme/
+[gh-gems]: https://pages.github.com/versions/
+[ani-css]: https://daneden.github.io/animate.css/
+[sm-gh-pages]: https://www.smashingmagazine.com/2014/08/build-blog-jekyll-github-pages/
+
+[1]: https://manid2.github.io/lone-wolf-theme/
+[2]: https://manid2.github.io/
+[3]: https://manid2.github.io/lone-wolf-theme/contribute/

assets/js/main.min.js

@@ -1,5 +1,5 @@
 /*!
- * lone-wolf-theme v1.0.4 by Mani Kumar for Jekyll.
+ * lone-wolf-theme v1.0.5 by Mani Kumar for Jekyll.
  * https://manid2.github.io/lone-wolf-theme/
  * @manid2
  * Licensed under MIT

docs/_config.dev.yml

@@ -4,10 +4,3 @@ url: http://localhost:4000
 
 analytics:
   provider: false
-
-comments:
-  disqus:
-    shortname            : "lwt-dev"
-
-sass:
-  style: expanded

docs/_pages/about.md

@@ -4,32 +4,39 @@ title: "About"
 permalink: /about/
 ---
 
-*A short story behind making of this theme.*
+_The short story behind making of this theme._
 
-This is lone-wolf-theme for Jekyll websites. Developed as an exercise for my web development skills.
-As a part time solo freelancer I faced bad experiences in dealing with the clients.
-Due to no established processes and formal communications people did not take me seriously.
-Also ended up working without pay for some time.
+This theme is developed as a learning experience.
+Since there are no good bootstrap based themes for jekyll.
+So I took up this opportunity to create a bootstrap based, github pages
+compatible jekyll theme.
 
-So I felt the need to formalize the communication process with the clients.
-Inspired by websites like [upwork](https://www.upwork.com/), [bonsai](https://www.hellobonsai.com/), I decided
- to make my own theme with all the necessary [features]({{ '/features/' | absolute_url }}) for a freelancer.
+The knowledge to develop this theme is borrowed from the below two popular jekyll themes:
 
-By making use of the source code from two well known free and open source jekyll themes
- [minimal mistakes](https://mmistakes.github.io/minimal-mistakes/) and [cards](https://webjeda.com/cards/)
- I made a simple version of this theme. It is highly oriented towards the solo freelancers who either starting out
- or well established.
+- [Minimal Mistakes][5]
+- [Webjeda Cards][6]
 
 ## <i class="fas fa-balance-scale"></i><span class="ml-1">License</span>
 
-Released under [MIT license](https://github.com/manid2/lone-wolf-theme/blob/master/LICENSE)
- it is flexible for open source and commercial uses.
+Released under [MIT license][8] it is flexible for open source and commercial
+uses.
 
 ## <i class="far fa-handshake"></i><span class="ml-1">Credits</span>
 
-* [Bootstrap](https://getbootstrap.com/)
-* [Bootswatch](https://bootswatch.com/)
-* [Font Awesome](https://fontawesome.com/)
-* [Pexels](https://www.pexels.com/)
-* [Minimal Mistakes](https://mmistakes.github.io/minimal-mistakes/)
-* [Webjeda Cards](https://webjeda.com/cards/)
+- [Bootstrap][1]
+- [Bootswatch][2]
+- [Font Awesome][3]
+- [Pexels][4]
+- [Minimal Mistakes][5]
+- [Webjeda Cards][6]
+- [animate.css][7]
+
+<!-- links in this post -->
+[1]: https://getbootstrap.com/
+[2]: https://bootswatch.com/
+[3]: https://fontawesome.com/
+[4]: https://www.pexels.com/
+[5]: https://mmistakes.github.io/minimal-mistakes/
+[6]: https://webjeda.com/cards/
+[7]: https://daneden.github.io/animate.css/
+[8]: https://github.com/manid2/lone-wolf-theme/blob/master/LICENSE

docs/_pages/apps.md

@@ -4,8 +4,8 @@ title: "Applications"
 permalink: /apps/
 ---
 
-This page is for listing your applications or the portfolio that you worked on your personal timings.
+**List your applications.**
 
-This is also known as the side projects.
+_This is a placeholder page to list your apps or write your own story._
 
-**TODO:** Need to decide whether to make a archive-lists or use simple page.
+_This page can be anything of your choice._

docs/_pages/contribute.md

@@ -0,0 +1,46 @@
+---
+layout: page
+title: "Contribute"
+permalink: /contribute/
+---
+
+List of things you can contribute to [LWT][lwt].
+
+- Add or request a new feature.
+- Fix or raise a github issue to fix a bug.
+- Improve development process as I am not native to ruby development.
+- Add documentation or samples to demonstrate the theme and its features.
+- Market, spread and enhance its usage if you like it.
+
+Prize for your contribution
+
+- Recognition
+- Work Experience
+
+## Guidelines
+
+Please follow the below guidelines to contribute to LWT.
+
+LWT uses `Fork, modify and submit Pull Request` model to collaborate.
+
+### Branch naming rules
+
+Permanent branches, these are protected.
+
+1. master - latest and stable product.
+
+Temporary branches, for development, are deleted after merging with master
+branch.
+
+1. feature-id
+2. bugfix-id
+3. hotfix-id
+4. docfix-id
+
+## Tips
+
+- Use project boards for raw ideas and non code information.
+- Use github issues for project ideas implementation.
+
+<!-- Links -->
+[lwt]: https://github.com/manid2/lone-wolf-theme

docs/_pages/features.md

@@ -6,26 +6,27 @@ permalink: /features/
 
 ## Front End
 
-* Bootstrap based theme enhanced further with the Bootswatch wrappers.
-* Uses font awesome 5 for icons.
-* Deliberately kept simple in design to give more attention to content and functions.
-* Has 4 unique layouts home, page, post and archive posts.
-* Easily extendable by deriving from the default layout.
-
-### TODO
-
-* Add support for Magnific popup for lightbox effect
-* Use animate.css and hover.css to achive animations.
+- Has 4 unique layouts `home`, `page`, `post` and `archive` posts.
+- Easily extensible to add more layouts such as `list` or `grid` layout.
+- Bootstrap based theme enhanced further with the Bootswatch wrappers.
+- Uses animate.css for animations.
+- Uses font awesome 5 for icons.
+
+## Gems
+
+- Optimized for search engines using [Jekyll Seo Tag gem][1].
+- Uses the below gems.
+  - jekyll-paginate
+  - jekyll-sitemap
+  - jekyll-gist
+  - jekyll-feed
+  - jekyll-seo-tag
+  - jekyll-data
+  - jemoji
+- Github pages compatible..
 
 ## Others
 
-* Plugins are added to the site by adding javascript to javascript folder in assets directory.
-* If any css or sass comes with the plugin then it is added to \_sass folder or the css folder assets directory.
-* Optimized for search engines using [Jekyll Seo Tag](https://github.com/jekyll/jekyll-seo-tag) gem.
-* Github pages compatible.
-
-### TODO
+- Javascript plugins can be added to `assets/js/` to include a new feature.
 
-* Add support for site analytics such as google analytics.
-* Add support for comments on blog posts.
-* Site search function.
+[1]: https://github.com/jekyll/jekyll-seo-tag

docs/_pages/home.md

@@ -3,14 +3,14 @@ layout: home
 permalink: /
 
 title: "Lone Wolf Theme"
-excerpt: "Simple and elegant website theme for freelance business using Bootstrap 4 with Jekyll."
+excerpt: "A simple bootstrap based jekyll theme."
 action: true
 action_btn:
   - label: "Download"
     fa_icon : "fas fa-download"
     class: "btn btn-lg btn-success"
     url: "https://github.com/manid2/lone-wolf-theme/releases/latest"
-  - dropdown: true
+  - dropdown: false
   - dropdown_items:
     - label: "v1.0.2"
       url: "https://github.com/manid2/lone-wolf-theme/releases/tag/v1.0.2"
@@ -36,71 +36,63 @@ feature_rows:
 
 ## Introduction
 
-Lone Wolf Theme is targeted at freelancers who run their business and wants to manage it on a Jekyll 
-generated website. It is infamous for abstracting away the frontend code using Bootstrap 4 and Bootswatch 
-themes to help us focus only on the <span class="badge badge-primary">content</span> and the 
-<span class="badge badge-primary">functions</span>. It is in the most basic version now due to my 
-hectic schedule at work and other responsibilities. Will quickly add features from my todo lists to make 
-this theme unique and great.
-
-This theme is inspired by the fact that there is a lack of good boostrap based theme for Jekyll.
-Bootstrap is a popular frontend framework for websites used for keeping consistency in the code and is 
-easy to maintain and extend. Have used a freely available theme for jekyll, like [minimal mistakes][1].
-But since it is a generic theme it didn't meet my specific needs (i.e. manage my freelance business).
-And it is too difficult to make changes to their code base. Hence by using the bootstrap the frontend code is 
-abstracted away and it is very easy to extend it in the future.
-
-100% github pages compatible and also available in gem version from [rubygems.org][3].
-{: .lead}
-
-List of functions the freelancers encounter in their business that this theme intends to handle by providing
-an interface to the end users:
-
-<ul class="list-group d-inline-block mb-3">
-  <li class="list-group-item">
-    Formalize and record the client communications.
-  </li>
-  <li class="list-group-item">
-    Self owned web portal to handle the freelance business.
-  </li>
-  <li class="list-group-item">
-    Simple blog layout.
-  </li>
-  <li class="list-group-item">
-    Idea submission form, etc.
-  </li>
-</ul>
-
-<p class="bg-success text-white p-3 rounded">It is aimed at the solo freelancers who host their <span
-    class="badge badge-info">portfolios</span>,
-  take <span class="badge badge-info">ideas</span> form submission,
-  have a <span class="badge badge-info">todo</span> lists to achieve their goals and
-  host a <span class="badge badge-info">blog</span> to pen their thoughts.
-</p>
+Lone Wolf Theme is a simple bootstrap based jekyll theme.
+It is infamous for abstracting away the frontend code using [Bootstrap 4][bs4]
+and [Bootswatch wrappers][bootswatch] to help us focus on the
+ <span class="badge badge-primary">content</span> and the
+ <span class="badge badge-primary">functions</span>.
+
+Since there is no good boostrap based theme for [jekyll][jekyll]
+I have created this theme in my free time.
+To learn both the web development and contribute to open source softwares.
+
+Have used popular jekyll themes such as [minimal mistakes][min-mis].
+And I wanted to have my own theme so I can modify it to suit my needs.
+
+Bootstrap is a popular frontend framework for websites.
+It is used for consistency in the code and is easy to maintain and extend.
+Bootswatch is a wrapper theme for plain bootstrap.
+It enhances the plain bootstrap to a great extent.
+
+LWT is compatible with github pages.
+It uses [animate.css][ani-css] for animations.
 
 ## Installation
 
 ### Using remote theme
 
-Easiest way to use the theme if you dont want to make changes to the theme's code.
+Easiest way to use the theme if you dont want to make changes to the theme's
+code.
 
-* Add `remote_theme    : "manid2/lone-wolf-theme"` to your `_config.yml` file.
+- Add `remote_theme    : "manid2/lone-wolf-theme"` to your `_config.yml` file.
 
 ### By forking the theme repository
 
 If you want to make changes to the code and to truly own the site.
-Follow the blog on smashing magazine to learn about this method [here][2].
+Follow the blog on [smashing magazine][sm-gh-pages] to learn about this method.
 
 ### As a ruby gem
 
-When you want to host the site on any server other than the github pages and also to make use of plenty
-of jekyll plugins.
+When you want to host the site on any server other than the github pages
+and also to make use of plenty of jekyll plugins.
+
+- Add `gem "lone-wolf-theme"` to your `Gemfile`.
+- Update bundled gems by using `bundle` command.
+- Add `theme    : "lone-wolf-theme"` to your `_config.yml`.
+
+## Contribution
 
-* Add `gem "lone-wolf-theme"` to your `Gemfile`.
-* Update bundled gems by using `bundle` command.
-* Add `theme    : "lone-wolf-theme"` to your `_config.yml`.
+Use the link to learn how to [contribute][3] to LWT.
 
 <!-- Links in the post -->
-[1]: https://mmistakes.github.io/minimal-mistakes/
-[2]: https://www.smashingmagazine.com/2014/08/build-blog-jekyll-github-pages/
-[3]: https://rubygems.org/gems/lone-wolf-theme
+[jekyll]: https://jekyllrb.com/
+[min-mis]: https://mmistakes.github.io/minimal-mistakes/
+[sm-gh-pages]: https://www.smashingmagazine.com/2014/08/build-blog-jekyll-github-pages/
+[bs4]: https://getbootstrap.com/
+[bootswatch]: https://bootswatch.com/
+[gh-gems]: https://pages.github.com/versions/
+[ani-css]: https://daneden.github.io/animate.css/
+
+[1]: https://manid2.github.io/lone-wolf-theme/
+[2]: https://manid2.github.io/
+[3]: {{ '/contribute/' | relative_url }}