Skip to content

Latest commit

 

History

History
executable file
·
139 lines (98 loc) · 9.58 KB

README.md

File metadata and controls

executable file
·
139 lines (98 loc) · 9.58 KB
Raw

[English] [日本語]

Mr. Green Jekyll Theme

GitHub issues GitHub forks GitHub stars GitHub license Tip Me via Patreon Tip Me via Ko-fi

Introduction

Mr. Green is a multilingual theme generated with Jekyll and fully compatible with GitHub Pages.

I was going to make my website and thought if I did it as a template, I could share it with the open source community. That's why I decided to build it as a theme. I've worked so hard to make this possible so I'm happy if you consider supporting me. Thanks.

Features

  • Multilingual web site
    • English (default), Japanese (日本語)
  • Recommended language offer feature
  • Auto Navigation Button adder with icon enable disable options
  • Layouts for Home, About, Archives, Post-list, Links, Projects and more
  • Color scheme switching options (Dark light)
  • Auto Contact option adder
  • Auto image referrer (no need to add full path for images. Just add : in front of it.)
  • image lazy loader, image viewer
  • Cool Footer with creative commons licensing
  • Movable Table of Contents modal box for Posts
  • Post Share Options
  • Post-listing by Category or Tags
  • Comments for posts
  • Selectable numbered pagination or scroll to load type
  • Sitemap feature
  • Search Engine Optimization (SEO)
  • Analytics (Google Analytics)
  • Cookie consent feature
  • Site Search feature
  • Code Compression for small footprint (HTML JS SCSS)
  • Mobile App support
  • Mobile device friendly (Tested on Android and IOS)
  • Well organized folder structure for developers (Tested on Chrome, Safari, FireFox)

Installation

Github pages

  1. Fork the repo.

  2. Edit _config.yml and change url like below and push changes.

    url: "https://your_github_user_name.github.io"

  3. Rename the repo name to your_github_user_name.github.io

  4. Check Deploy status Actions tab on the repo.

  5. When it's turned to green, your site is up and running at https://your_github_user_name.github.io

Local build

  1. Install Jekyll to your OS
  2. Clone or download the repo, in command prompt go to the folder run bundle install command
  3. Build using bundle exec jekyll serve --watch --host 0.0.0.0 --safe command
    • with --host 0.0.0.0 parameter you can access web server from same lan.
    • with --safe parameter you can make sure no 3rd party plugin added. (for Github pages development)
  4. Your page will be up and running at the 0.0.0.0:4000/ address.

Documentation

Check out Mr. Green theme tutorials playlist on YouTube

Credits

I want to thank these projects that gave me an opportunity to build my web site.

  • Jekyll is a static site generator. It takes text written in your favorite markup language and uses layouts to create a static website. You can tweak the site’s look and feel, URLs, the data displayed on the page, and more. It is a wonderful project which is maintained by volunteers.

  • GitHub Pages Hosted directly from your GitHub repository. Just push the changes and the site will be automatically generated.

Some of the sites that I find useful while I'm working on this project. links page

You Can Support My Work

Creating projects starting from nothing takes a great amount of time. Much appreciated if you consider supporting me so that I can continue projects like this and creating new contents for everyone.

  • You can support me on GitHub Sponsors (monthly or one time)
  • You can be one of my patrons on Patreon (monthly)
  • You can tip me via Ko-fi (one time)

Contribute

Pull Requests are welcome. Please check the instructions in the Issues and Pull Request templates.

License

As it says in the MIT license, you can use this theme anywhere as long as you include the license and copyright notice.

Copyright (c) 2022 Mr. Green's Workshop https://www.MrGreensWorkshop.com

Please add link to my page or leave the "Pwrd by Mr. Green" link in the footer so I can get credit for my work.

Thank you!

Other Licenses

Mr. Green Jekyll Theme incorporates libraries written below. Without these libraries, I couldn't make this project possible.

Library file
jQuery v3.6.0, Copyright OpenJS Foundation and other contributors. jQuery is distributed under the terms of the MIT License. jquery-3.6.0.min.js
Bootstrap v3.3.7, Copyright (c) 2011-2016 Twitter, Inc. Bootstrap is distributed under the terms of the MIT License. bootstrap.min.js, bootstrap.min.css
Bootstrap Table of Contents v0.4.1, Copyright (c) 2015 Aidan Feldman Aidan Feldman. Bootstrap Table of Contents is distributed under the terms of the MIT License. bootstrap-toc.min.js, bootstrap-toc.min.css
Font Awesome v4.7.0, Copyright (c) 2017 Dave Gandy. The Font Awesome font is distributed under the terms of the SIL OFL 1.1. Font Awesome CSS, LESS, and Sass files are distributed under the terms of the MIT License. font-awesome.min.css, FontAwesome
Lozad.js v1.16.0, Copyright (c) 2017 Apoorv Saxena. Lozad.js is distributed under the terms of the MIT License. lozad.min.js
Magnific Popup v1.1.0, Copyright (c) 2014-2016 Dmitry Semenov, http://dimsemenov.com. Magnific Popup is distributed under the terms of the MIT License. jquery.magnific-popup.min.js, magnific-popup.css
Simple-Jekyll-Search v1.9.2, Copyright (c) 2015 Christian Fei. Simple-Jekyll-Search is distributed under the terms of the MIT License. simple-jekyll-search-1.9.2.min.js
Compress HTML in Jekyll v3.1.0, Copyright (c) 2014 Anatol Broder. Compress HTML in Jekyll is distributed under the terms of the MIT License. compress.liquid

Mr. Green Jekyll Theme