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: https://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:
-
Install Jekyll and Bundler
gem install jekyll bundler
-
Create a new Jekyll app
jekyll new jekyllapp
-
Enter the new directory
cd jekyllapp
-
Then follow the instructions below like existing Jekyll app.
Then for existing Jekyll apps,
-
Install Bundler if haven't done so.
gem install bundler
-
Remove Jekyll auto-generated default pages
404.html
,about.markdown
andindex.markdown
or any your custom layouts or existing theme files. -
Remove the existing
Gemfile.lock
. -
Download the respository here and locate
starter-kit
folder, or downloadstarter-kit
folder directly here. -
Put everything in the
starter-kit
in the root directory, i.e.jekyllapp
in this example. -
Run
bundle install
to install dependencies. -
Run Jekyll with
bundle exec jekyll serve
-
Hack away at http://localhost:4000!
As a fork
-
Fork the repo here
-
Clone the repo just forked.
git clone git@github.com:[YOUR_USERNAME]/jekyll-theme-simple-texture.git
-
Delete
starter-kit
folder andjekyll-theme-simple-texture.gemspec
file (they're for people installing via gem) -
Install Bundler if haven't done so.
gem install bundler
-
Update the
Gemfile
to look like the following:source "https://rubygems.org" gem "github-pages", group: :jekyll_plugins
-
Run
bundle install
to install dependencies. -
Run Jekyll with
bundle exec jekyll serve
-
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
-
JavaScript
-
Fonts
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.