README-EN.md

简体中文 | English

knightyun.github.io

A responsive personal blog website based on jekyll.

Features

• Responsive for mobile phone, tablet, desktop | Preview
• Show your GitHub repository fantastically | Preview
• Archive your articles with categories and tags | Preview
• Support search articles with key words | Preview
• Article comment and site message board | Preview
• Customized “About” page | Preview

Usage

Detailed tutorial：Build Github Pages blog website

jekyll guide：https://www.jekyll.com.cn/

Configuration

The configuration file _config.yml locates in the root directory, looking for more details about the parameters of this file, please see the official documentation: https://www.jekyll.com.cn/docs/configuration/

Example config of my website:

# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Global variable, can use it in HTML file,
# for example: <h1>{{ site.title }}</h1> 
title: 瑝琦的博客 # title for your website
description: > # description for your website, useful for search engine exhibition.
  基于 jekyll 的 Github Pages 个人博客网站，技术的学习、总结、分享与提升
url: "https://knightyun.github.io" # address of your website.
github_repo: knightyun/knightyun.github.io
github_profile: "https://github.com/knightyun" # your GitHub home page.
user: "瑝琦" # name in the sidebar
user_email: "2386209384@qq.com" # contact email in the sidebar
paginate: 5 # how many articles will show in your website home page.

# configuration related to jekyll
markdown: kramdown
repository: knightyun/knightyun.github.io
plugins:
  - jekyll-feed
  - jekyll-paginate
  - jekyll-seo-tag
  - jekyll-sitemap
exclude:
  - Gemfile
  - Gemfile.lock
  - vendor
  - README.md
  - COPYING
sass:
  style: compressed
future: true
permalink: /:year/:month/:day/:title

Development

Commit and push your code to the remote repo, you may wait for a long time to see the change of your blog website, so recommend build develop environment in local, convenient for debugging.

Detialed tutorial: Install jekyll

run code bellow in shell after configuring well：

bundle exec jekyll s

Then shell will print a message about open http://127.0.0.1:4000 in browser to preview the website. Normally, what you see is the same as real GitHub Pages website, so, push your code to github after testing it well.

Libraries

• Materialize.css：Famous materialize css style library.
• GeoPattern：Generate intersting backgroud images.
• particles.js：Particle lines effect.
• Valine：Blog article comment plugin.

Reference

• https://github.com/ShawnTeoh/matjek

License

GPL v3