Code Monkey home page Code Monkey logo

jekyll-theme-simple-texture's Introduction

Simple Texture Jekyll Theme

Gem Version

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

Screenshot - Home

Screenshot - 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 Bundler

    gem install jekyll bundler
    
  2. Create a new Jekyll app

    jekyll new jekyllapp
    
  3. Enter the new directory

    cd jekyllapp
    
  4. Then follow the instructions below like existing Jekyll app.

Then for existing Jekyll apps,

  1. Install Bundler if haven't done so.

    gem install bundler
    
  2. Remove Jekyll auto-generated default pages 404.html, about.markdown and index.markdown or any your custom layouts or existing theme files.

  3. Remove the existing Gemfile.lock.

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

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

  6. Run bundle install to install dependencies.

  7. Run Jekyll with bundle exec jekyll serve

  8. 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 "github-pages", group: :jekyll_plugins
  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

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.

jekyll-theme-simple-texture's People

Contributors

ittaj avatar yizeng avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

jekyll-theme-simple-texture's Issues

"Language Codes" caused by the error

Hello, there is a bug here when I set lang to zh in the _config.yml file and then Categories, Tags, Search, About can not be displayed.

# _config.yml
# Site Settings
encoding: UTF-8
exclude: ["*.gem", "*.gemspec", "Gemfile", "Gemfile.lock", "node_modules", "Rakefile", "starter-kit", "vendor"]
#lang: en
lang: zh
...

2017-07-07_22-27-07

2017-07-07_22-29-15

How do I add more pages?

Hello! I really like your theme and it's the only I've found that will work perfectly with this communal site I'm developing, the only thing is I'm not sure how to add more pages or sections (not sure what you call them lol).

The communal site I am developing is for me and some friends to showcase our books. What I want to do is add a section for each book that shows the book cover, description, and author name, how do I do that?

Sorry if this is an easy question with a simple answer, I'm just starting out with web development and Jekyll and don't know a lot.

Page build failed when deploy on GitHub

Hi,

Thanks for providing this awesome theme. I really like it.

However, an error message shows when I upload starter-kit to GitHub.

The page build failed for the `master` branch with the following error:
A file was included in `blog/tags/index.html` that is a symlink or does not exist in your `_includes` directory. For more information, see https://help.github.com/articles/page-build-failed-file-is-a-symlink/.

My repository is here.

I was wondering if you would like to take some time and let me know what is the right way to fix this?

Thanks,
HONG

LaTeX Support

Greetings,

Firstly, thank you for providing this awesome theme. It is really good.

Yet, I was wondering if you would like to add a LaTeX support for this theme, like MathJax. It will be super useful if we could use LaTeX on our blog.

Here is a useful link I found might be able to help you save your time: How to supported latex in github-pages.

Again, thank you very much for sharing this great theme. I am looking forward to new features.

Best,
H. HONG

DownGit Link flagged

Hey,
Just wanted to give you a heads up that the DownGit link for the quickstart folder is flagged as malicious. This is probably due to the re-director being minhaskamal.github.io.

Relevant discussion item here.

Accessibility errors found in your template

The user @carlsonsantana validate your site template "https://yizeng.github.io/jekyll-theme-simple-texture/" and found these accessibility errors:

  • Page https://yizeng.github.io/jekyll-theme-simple-texture/:
    • Issue 060f76c7-3d02-448a-be49-baca7fe03981:
      • Type: Error
      • Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
      • Message: This link points to a named anchor "social" within the document, but no anchor exists with that name.
      • Selector: #menu > li:nth-child(2) > a
      • Context: <a href="#social">Social Links</a>
    • Issue a9d12111-8513-45d1-b5c2-b7ad019a817d:
      • Type: Error
      • Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
      • Message: This link points to a named anchor "bio" within the document, but no anchor exists with that name.
      • Selector: #menu > li:nth-child(1) > a
      • Context: <a href="#bio">Biography</a>
    • Issue 35798300-0879-46db-aba5-df6a0f9456fc:
      • Type: Error
      • Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
      • Message: This link points to a named anchor "social" within the document, but no anchor exists with that name.
      • Selector: #fullPage-nav > ul > li:nth-child(2) > a
      • Context: <a href="#social"><span></span></a>
    • Issue 225fea9f-a5d3-4804-a987-25fbf93aef9f:
      • Type: Error
      • Code: WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.A.NoContent
      • Message: Anchor element found with a valid href attribute, but no link content has been supplied.
      • Selector: #fullPage-nav > ul > li:nth-child(2) > a
      • Context: <a href="#social"><span></span></a>
    • Issue 115e9799-5bbf-4b04-b75a-143a63c81b10:
      • Type: Error
      • Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
      • Message: This link points to a named anchor "bio" within the document, but no anchor exists with that name.
      • Selector: #fullPage-nav > ul > li:nth-child(1) > a
      • Context: <a href="#bio" class="active"><span></span></a>
    • Issue 9635018d-cd47-49b6-914e-40325b936bb7:
      • Type: Error
      • Code: WCAG2AA.Principle4.Guideline4_1.4_1_2.H91.A.NoContent
      • Message: Anchor element found with a valid href attribute, but no link content has been supplied.
      • Selector: #fullPage-nav > ul > li:nth-child(1) > a
      • Context: <a href="#bio" class="active"><span></span></a>
    • Issue d378f652-3a85-4abb-949a-51e80d87d088:
      • Type: Error
      • Code: WCAG2AA.Principle2.Guideline2_4.2_4_1.G1,G123,G124.NoSuchID
      • Message: This link points to a named anchor "social" within the document, but no anchor exists with that name.
      • Selector: #section0 > div > a
      • Context: <a class="btn-continue animated bounce" title="More" href="#social"></a>

You can check these accessibility errors using pa11y.
You can view the full validation results in our website.

How to use without 'home' page

Hi! It is very good theme i think.
However, i want use this theme without 'home' page. (just blog, tags, categories)
Is that possible?

How to change the icon of the whole webpage?

Having seen yizeng.me/blog, I found all the icons of your pages are changed to (maybe?) a favicon.ico.
But when I just added an .ico file, the webpage's icon only changed at the home, the icon of post and blog pages remained blank.
How can I fix this? I have tried "link" way in html files also, but this didn't work for me.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.