Before using it, you may need Bower and Bundler on your local to install dependencies.
- Fork code and clone
- Run
bower installto install all dependencies in bower.json - Run
bundle installto install all dependencies in Gemfile - Update
_config.ymlwith your own settings. - Add posts in
/_posts - Commit to your own Username.github.io repository.
- 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
For the moment, when you test on your local, you need to keep internet connection. Bug will be fixed soon.
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
- 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.
The Apache License 2.0
Copyright (c) 2016 DONG Chuan
Check LICENSE file and official website for details