Skip to content

yieryi/yieryi.github.com

Repository files navigation

Jekyll Paper for Github

Jekyll Paper

Jekyll Paper is a simple Jekyll theme, and it is aim to helping you to create your own blog by the easiest way. Jekyll Paper was designed as a paper book style, giving the reader a sense of what it looked like to read a paper book.

Jekyll Paper for Github is the sub-project for Jekyll Paper, it only contains Github Pages environment supported plugins.

This is a demo website for Jekyll Paper for Github.

Screenshots

Index Screenshot

Post Screenshot

Category Screenshot

Features

  • Responsive
  • Paginate
  • RSS
  • Sitemap
  • Custom 404 page
  • SASS
  • Multiple languages support
  • Configurable navigation menu
  • SEO optimization
  • Comments
  • Category Index
  • Mathematics
  • Diagrams

Getting Start

Jekyll Paper for Github is easy to create your own blog. You can create your blog by four steps only!

  1. Fork your own copy of Jekyll Paper for Github repository to your Github account.
  2. Open setting page of your repository.
  3. Change repository name to your_github_username.github.io.
  4. Enter your_github_name.github.io.

Add New Posts

You can add new posts at any time after you had your own blog. Create a new post need to add a new file in "_posts" directory, and the file name must follow the convention YYYY-MM-DD-name-of-post.md.

Custom Navigation Menu

You can add or update navigation menu items in _data/menus.yml file. In the configuration file, you need set title and URL for every navigation menu item.

Example

- title: "Index"
  url:   ""

- title: "About"
  url:   "about"

Supported Languages

This list order by language codes alphabets.

  • English
  • Deutsche (German)
  • Español (Spanish)
  • Français (French)
  • 日本語 (Japanese)
  • Português (Portuguese)
  • 简体中文 (Simplified Chinese)
  • 繁體中文 (Traditional Chinese)

License

Jekyll Paper for Github was released under MIT license.

Contributing

If you would like to make Jekyll Paper for Github better, you can create a new pull request in Jekyll Paper Github Page.

If you have any questions or suggestions, you can create an issue on Jekyll Paper for Github Issues or send email to me.

Chinese Version

Jekyll Paper for Github项目提供了中文版的使用介绍文档