StartZeroGnu/writers-zone

:gem: Gem Theme for Jekyll based on the official theme minima :warning: :construction:

writers-zone 💎

Gem Theme for Jekyll based on the (official theme minima by Parker Moore) with some plugins installed.

⚠️ 🚧 This theme is a work in progress (daily/weekly updates)

Features

• Mobile friendly (Responsive desing mobile first)
• FlexBox layout
  • compatibility with all browsers "desktop/mobile" less
  • IE < 10
  • Opera "desktop/mobile" < 12.1
• Sticky footer
• Toggle menu on-click with only CSS
• Full text search
• SVG icons

Installation

~ $ gem install writers-zone

~ $ jekyll new My-New-Blog

Quick Usage

Copy all files from "demo" folder in the root of your Jekyll site

and then execute

~ $ bundle exec jekyll serve

# http://localhost:4000

Add icons

Svg Icons collection Octicons v.4.3.0

Add basics icons ( e.g. about page ), this tag sends 2 params [ icon-name, class ]

Classes

• By Default ( vertical-align: text-bottom, fill: $grey-color )
• text-top ( vertical-align: text-top )
• c-color ( fill: currentColor )

Icon names

• Same as Octicons collection

{% include icons/icon.html
  icon-name='alert'
  class='text-top'
%}

2 classes class='text-top c-color'

Add User icons ( e.g. GitHub ), this tag sends 3 params [ icon-name, href, username ]

Href

• site url without "/" at the end

Username

• reads github_username in _config.yml

{% include icons/user.html
  icon-name='github'
  href='https://github.com'
  username=site.github_username
%}

Plugins

• Jekyll Feed by Ben Balter more info about plugin and configs
• Jekyll Gist by Parker Moore more info about plugin and configs
  • Usage
  • {% gist StartZeroGnu/8b038a1a07b8f7aa8e429960e1500662 %} (entire gist with all files)
  • {% gist StartZeroGnu/8b038a1a07b8f7aa8e429960e1500662 demo2.md %} (to show just the specified file)
• Jekyll Paginate by Parker Moore more info about plugin and configs
• Jekyll SEO by Ben Balter more info about plugin and configs
• Jekyll Sitemap by Ben Balter more info about plugin and configs
  • Usage
  • To exclude specific pages/posts set sitemap: false in the front matter of the page/post
• Simple Jekyll Search by Christian Fei more info about plugin and configs

Credits and Thanks

• Jekyll (3.2.1)
• Jekyll Docs | Themes
• Minima (1.2)
• RubyGems
• Jekyll Feed
• Jekyll Gist
• Jekyll Paginate
• Jekyll SEO
• Jekyll Sitemap
• Simple Jekyll Search
• Octicons

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/StartZeroGnu/writers-zone/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The theme is available as open source under the terms of the MIT License.