其实按照作者的意思,我应该这么写README
这是从qwtel那里偷来的伟大的杰作(大雾)
这下面是原作者的README,我就原封不动的放在这里吧,大家喜欢这个模板的就去原作者那里下载吧,记得给原作者star哦。
MIT License
Hydejack is a pretentious two-column Jekyll theme, stolen by @qwtel
from Hyde. You could say it was.. hydejacked.
Unlike Hyde, it's very opinionated about how you are going to use it.
Features include:
- Touch-enabled sidebar / drawer for mobile, including fallback when JS is disabled.
- Github Pages compatible tag support based on this post.
- Customizable link color and sidebar image, per-site, per-tag and per-post.
- Optional author section at the bottom of each post.
- Optional comment section powered by Disqus.
- Layout for posts grouped by year
- Wide array of social media icons on sidebar.
- Math blocks via KaTeX.
Hydejack is developed on and hosted with GitHub. Head to the GitHub repository for downloads, bug reports, and feature requests.
I love the original Hyde theme, but unfortunately the layout isn't as great on small screens. Since the sidebar moves to the top, the user has to scroll down just to read the title of a blog post.
By using a drawer component I was able to retain the original two column layout. It's possible to move the drawer via touch input (with the help of a little JavaScript).
Since the background image contributes to the feel of the page I'm letting it peek over the edge a bit. This also provides a hint to the user that an interaction is possible.
You can configure important aspects of the theme via _config.yml
. This includes:
- the blog description in the sidebar
- the (optional) author description and photo
- default image and link color of the blog
- the github and twitter usernames
In the manifest of a blog post, simply add an url as image
and a CSS color as color
:
layout: post
title: Introducing Hydejack
image: http://qwtel.com/hydejack/public/img/hyde.jpg
color: '#949667'
Tags are possible, but they are not meant to be used #instagram #style: #food #goodfood #happy #happylife #didimentionfood #yougetthepoint. Each tag requires some setup work. I tend to think of it as categories that can be combined.
-
Add an entry to
_data/tags.yml
, where the key represents a slug and provide at least aname
value and optionallyimage
,color
anddescription
.Example
/_data/tags.yml
:mytag: name: My Tag
-
Make a new file in the
tag
folder, using the same name you've used as the key / slug and change thetag
andpermalink
entries.Example
/tag/mytag.md
:layout: blog-by-tag tag: mytag permalink: /tag/mytag/
-
Tag your blog posts using the
tags
key (color and image will only depend on the first tag).layout: post title: Introducing My New Tag tags: [mytag, othertag]
-
(optional) Add the tag to the sidebar, by adding it to
sidebar_tags
in_config.yml
. They will appear in the listed order.sidebar_tags: [mytag, othertag]