Git Product home page Git Product logo

yummy-jekyll's Introduction

Yummy Jekyll Theme

A Simple, Bootstrap Based Theme. Especially for developers who like to show their projects on website and like to take notes. There are also some magical features to discover.

Open issues if you find bugs or even have trouble installing jekyll or dependencies. :D

Or contact: [email protected]

Strongly suggest to fork and change project name to create your GitHub Pages instead of downloading it directly. Because in the future, I will develop many funny modules like 'footprint' to show your world wide trip. Could be easier to merge new features in the future.

Notable Features

  • Compatible with Jekyll 3.x and GitHub Pages
  • Based on Bootstrap
  • Github Module to show your popular projects in a single page and on sidebar automatically. (Datas are retreived by github metadata instead of by api calls, so no delay)
  • Post Module to show all your posts with timeline
  • Bookmark Module to establish a quick mark about all libs/tools/books you like to use.
  • Post Navigation Module to generat a quick directory of your post by titles/subtitles automatically.
  • Support Disqus Comment
  • Support Google Analytics

Features in future:

  • A Footprint module to show all your travel around the world
  • Feature to share. (Facebook, twitter, evernote and so on)
  • (Not sure) A embeded todo list. (Not sure) to travel, to complete, to do for your parents, etc. To do in life!
  • Creative ideas to discuss with you :P

Install and setup

Before using it, you may need Bower and Bundler on your local to install dependencies.

  1. Fork code and clone
  2. Run bower install to install all dependencies in bower.json
  3. Run bundle install to install all dependencies in Gemfile
  4. Update _config.yml with your own settings.
  5. Add posts in /_posts
  6. Commit to your own Username.github.io repository.
  7. Then come back to star this theme!

When install dependencies by bundler or gem, you may have some errors depending on your environment.

Error about json. Check response of Massimo Fazzolari on Stackoverflow to quick fix your problem. (Please also use latest version instead of 1.9.3 mentioned in the response)

Error about jekyll-paginate. Please check here

Error about SSL_connect. Please check here and here

For the moment, when you test on your local, you need to keep internet connection. Bug will be fixed soon.

How to use

Create a new post

Create a .md file inside _posts folder.

Name the file according to the standard jekyll format.

2016-01-19-i-love-yummy.md

Write the Front Matter and content in the file.

---
layout: post
title: Post title
category: Category
tags: [tag1, tag2]
---

Please find examples here

Jekyll supports different structure of repository. You could just create as many folders as you want under _posts. Then jekyll will look through all folders/subfolders to find your posts. So cool, right? :D

When writing post, please always follow this format:

Description about this post, blablabla

## Title A

### Title A-1

### Title A-2

## Title B

### Title B-1

So, Title A, A-1, A-2, Title B, B-1 will be detected and created as a directory

For example, a demo post

But if you do not like it or your post is quite short. You want to hide this navigation to make your post occupy your full screen. You just need to set no-post-nav:true in the Front Matter of the post where you want to hide this feature :D

This module will get automatically all your repository information from github. But to test on your local, you must keep internet connection. In the future, it will also show the repositories you contributed a lot and the ones of your organization.

To add new marks, you only need to edit bookmark.md.

Feel free to customize about.me page to show yourself. You only need to modify about.md and about.html

ToDo

  • List posts by a specified tag
  • New module FootPrint to show your world around trips
  • Show projects from your orgnization on github. (Siderbar, in open-source page)
  • To fix bug - could only test on local with internet connected.

Contributor

License

The Apache License 2.0

Copyright (c) 2016 DONG Chuan

Check LICENSE file and official website for details

yummy-jekyll's People

Contributors

del-r avatar dongchuan avatar geminate avatar masonlouchart avatar mkoosej avatar shahsaurabh0605 avatar testuser3995 avatar xhmikosr 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  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

yummy-jekyll's Issues

[Proposal] Remove the comments on the homepage

I think the comments on the homepage are not really useful. The reason is, these comments will be out of context. Except if you want your visitors criticise your site generally.

capture d ecran 2016-08-31 a 00 16 18

What do you think about it ❓

failed to load *.min.css/js

bug detail

when i open my github pages , some script and css requests like https://emeralddreamland.github.io/bower_components/bootstrap/dist/css/bootstrap.min.css not found(404), but it is strange that i can access .../bootstrap.css and these files do exist.

fixed? failed to load resource

It looks like you are using Jekyll for your GitHub page. As for the Jekyll 3.3 from Nov 2016, the vender folder is ignored.
If you need those directories included in your site, set exclude: [] in your site's configuration file.
Hope it helps:)

then

I add "exclude: []" to my config.yml, it seems to work well now...

could you confirm this problem and fix it ?
yummy-jekll theme is awesome, thank u

你好。这个项目还维护吗?

你好,最近使用了你的这个模板搭建博客,但是发现没有全站搜索,并且子栏目在文章中是没有连接的,不方便跳转。后续若果可以的话,希望能做添加。

How to bundle the site locally

Hi,

I have installed all modules, but I got error installing 'nokogiri'.

I am using Ruby 3.0.

How to build this locally and push site to github?

GitHub Module Shows Out-of-Date Metadata

When a site is deployed to GitHub pages, the GitHub module works correctly at first -- it produces a list of open source repositories, with "last modified" dates, number of stars, etc.

However, the repository data does not update on subsequent visits to the site. For example, GitHub's feed notifies me that I have received two more stars on a repo, but on my site it still shows the old number of stars, and the old "last modified" date.

I understand the purpose of Jekyll is that it renders static site content. However, I would have imagined that the GitHub module is asynchronously making GitHub API calls to get the metadata. Otherwise it would be by design constantly out-of-date!

Is there something I am doing wrong? I do get this message when I run bundle exec jekyll serve locally:

GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.

提交最新的commit page会报错。

我给github官方发邮件,回复说,有可能是依赖的组件版本过低,我尝试了下更新相关的组件版本,但没有成功!

以下为邮件内容:

Hi ityouknow,

Here's the full error we're seeing:

[31m Liquid Exception: no implicit conversion of Integer into String in /_layouts/default.html[0m
[31m Fatal: TypeError[0m
[31m no implicit conversion of Integer into String[0m
You can also find this by building your site locally with Jekyll:

https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/

I notice in your Gemfile you're using some outdated dependancies that may be causing the Pages build process to fail. You may want to follow the instructions above, and make sure you're running the same versions of each dependancy listed on this page:

https://pages.github.com/versions/

Hope this helps!

Thanks,
Thomas

hi :

i don’t know why page build failure, I just modified a MD file, and now the page cannot be submitted again。

can you tell me the reason,Thank you for your reply.

希望_posts里面可以根据年份/月份分目录

博客模版很漂亮,我已经拿走搭建了自己的博客,但是在使用中我又一个小小的建议,是否可以在_posts里面按照年份来分一下目录,如果对一个博客输出量很多的人来讲,一年100多篇,回头在继续写博客的时候这里面的文件就太多了。

Jekyll Serve Fails (undefined method 'sort')

I clone this repo, then ran bundle install. When I try bundle exec jekyll serve, this is the console output:

msolters@samus:~/Downloads/Yummy-Jekyll$ bundle exec jekyll serve
Configuration file: /home/msolters/Downloads/Yummy-Jekyll/_config.yml
            Source: .
       Destination: ./_site
 Incremental build: disabled. Enable with --incremental
      Generating... 
   GitHub Metadata: No GitHub API authentication could be found. Some fields may be missing or have incorrect data.
  Liquid Exception: undefined method `sort' for false:FalseClass in _includes/about.html, included in about.md
jekyll 3.0.1 | Error:  undefined method `sort' for false:FalseClass

是否可以增加沉浸式阅读模式

现有主题下,阅读文章内容时,感觉内容的版面非常小,窄窄的,因为右边有导航栏占据。
我想能不能增加一个沉浸式的阅读交互:
1.只有一个内容版块,顶部有个关闭沉浸式模式的按钮。
2.无右边导航栏
3.无底部评论栏
4.增大内容区域
5.无顶部导航

Possible to hide post directory on certain posts?

Hi, firstly beautiful theme thank you so much for sharing. I was just wondering whether or not its possible or easy to hide the post directory sidebar from showing up on certain posts? I.e. some posts are so short and only 1 or maybe two paragraphs and just don't need this functionality.

Thanks in advance.

Jus.

能不能简单粗暴的直接出个中文版?

我突然发现这个主题里面的大部分东西都是英文,每次更新代码都要下载来再找文件然后把里面的东西改成中文太麻烦了。能不能直接开个新仓库把里面的东西翻成中文?或者,怎么在更新的时候把一些需要保留的东西保留下来?

Useless information on about-me page

On the "About" page, at the "Contact" section, the visitor can see two information which are email and Website. The second one is wrong (the link is pointing to the GitHub account) and useless (the visitor is already on the website).

capture d ecran 2016-08-16 a 02 15 43

The navbar animation makes me feel epileptic

The animation of the navigation bar in a post makes me feel epileptic. During the transitions, the color of the text and background are both white, and the menu seems disappeared. I think it could be more "beautiful" by removing the transition.

With transition

Original version.
post-nav-bar-animation

Without transition

Only the animation is disabled.
post-nav-bar-animation-without-transition

Without animation + different color

The animation is disabled and the background color is the same as the left border color.
post-nav-bar-animation-without-transition-with-different-color

Without animation + interchanged colors

The animation is disabled and the menu background and text colors are interchanged.
post-nav-bar-animation-without-transition-and-twiced-colors

I think at least the animation must be removed. About the colors, pick those you prefer.

Fetching own public repositories on github

I was for a long time trying to get my own public repositories in open-source page but failed to do so. Then I figured out that I had to add this line :
repository: shahsaurabh0605/shahsaurabh0605.github.io and it worked.

May be you should consider this.

对原作者的抱歉

事情是这样的,最开始在无意中看见这个主题(不是作者的博客),觉得非常的不错 在使用了一段时间的 Jekyll 觉得没有 Hexo 好用,于是就进行了移植 。

不过我一直不知道原作者是谁(主要是找错人了 ),今天这里才看见 这个主题的起源是这里 于是我更换了 1.0 的 README ,实在是抱歉!

Hexo-Theme-Primer

githud pages 显示问题

您好,请问githud pages {% for repo in sorted_repos %} 这个只能这样 遍历,我看了github pages 找不到,其他方式,对于自己的项目能够 只能显示几个,点击更多能分页。

求助

bfacd0f4-09eb-4b72-8ca2-28bc7dd11665

这个是什么问题啊......环境搭好了

[Suggestion] Occurred an dependency error while Installing 'bundle install'

Hi I'm your Yummy-Jekyll's fan.
I really appreciate to your Jekyll theme.
It's really beautiful. Thanks for your hard work.

While installing ruby plugins about section 3 on "install and setup", I have noticed one problem which can't find mkmf.rb. Actually, Most of developers can resolve this problem who know about ruby(gem installer).

But, I'm just a student. If my installation work was occurred an error, I'll be in panic. Therefore,I recommand you to add a notice message "it needs to ruby-dev. then, you should install the package 'ruby-dev' "

I don't know whether i messed up your issues board.
I really like your Jekyll theme. Thanks for your hard work again.

[Suggestion] Counting post.tags number is looks better than post.categories

Suggestion

Counting post.tags number is better than post.categories.

POST's side-nav Working

If i count number using post's categories size, My post url will be weired by what category array elements is url path.

Source

URL path is important about us, aren't we?
I wanna design URLs to RESTful, therefore i modified side-post-tag.html, like this.

  1. side-post-tag.html
   3     <ul class="list-group">
   4         {% for tag in site.tags %}
   5         <li class="list-group-item">
   6             {{ tag | first }}
   7             <span class="badge">{{ tag[1].size }}</span>
   8         </li>
   9         {% endfor %}
 10     </ul>
  1. any kramdown post.
---
title: bla bla bla
category : opensource     << -comment- it's important to clear for RESTful url
tags : [one, two three, four]
---

then url will be like this

https://drakejin.github.io/opensource/yyyy/MM/DD/bla-bla-bla.html

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.