README.md

Simple Texture Jekyll Theme

Simple Texture is a gem-based responsive simple texture styled Jekyll theme for Jekyll 3.3 or above, which can also be forked as a boilerplate for older versions of Jekyll.

Demo

• Starter-kit demo: https://yizeng.github.io/jekyll-theme-simple-texture/
• My own personal blog: http://yizeng.me/blog

Installation

As a Jekyll theme gem (Jekyll >= 3.3)

If you are creating a new website or blog, please follow the commands below first:

1. Install Jekyll and Bunlder

   gem install jekyll bundler
   

2. Create a new Jekyll app

   jekyll new jekyllapp
   

3. Enter the new directory

   cd jekyllapp
   

Then for newly created or existing Jekyll app,

1. Install Bundler if haven't done so.

   gem install bundler
   

2. Remove Jekyll auto-generated default pages about.md and index.md.

3. Download the respository here and locate starter-kit folder, or download starter-kit folder directly here.

4. Put everything in the starter-kit in the root directory, i.e. jekyllapp in this example.

5. Run bundle install to install dependencies.

6. Run Jekyll with bundle exec jekyll serve

7. Hack away at http://localhost:4000!

As a fork

1. Fork the repo here

2. Clone the repo just forked.

   git clone [email protected]:[YOUR_USERNAME]/jekyll-theme-simple-texture.git
   

3. Delete starter-kit folder and jekyll-theme-simple-texture.gemspec file (they're for people installing via gem)

4. Install Bundler if haven't done so.

   gem install bundler
   

5. Update the Gemfile to look like the following:

   source "https://rubygems.org"
   
   gem 'jekyll', '= 3.4.5' # locked in to be consistent GitHub Pages.
   
   group :jekyll_plugins do
     gem 'jekyll-feed'
     gem 'jekyll-redirect-from'
     gem 'jekyll-seo-tag'
     gem 'jekyll-sitemap'
   end

6. Run bundle install to install dependencies.

7. Run Jekyll with bundle exec jekyll serve

8. Hack away at http://localhost:4000!

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/yizeng/jekyll-theme-simple-texture. 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.

Credits

• Jekyll

  • jekyll-feed
  • jekyll-redirect-from
  • jekyll-seo-tag
  • jekyll-sitemap
  • Simple-Jekyll-Search
  • Jekyll-Bootstrap
  • theme-the-program

• Sass

  • Normalize.css
  • Animate.css
  • Simple Icons
  • Noise Texture Generator

• JavaScript

  • cdnjs
  • jQuery
  • fullPage.js
  • pace.js
  • Modernizr
  • FancyBox
  • unveil.js

• Fonts

  • Font Squirrel
  • Bitter
  • Junge
  • Ubuntu Condensed

License

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

MIT License

Copyright (c) 2017 Yi Zeng

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.