Merge branch 'release/1.1.0'1.1.0

9 files changed, 523 insertions, 29 deletions

diff --git a/LICENSE.md b/LICENSE.md
index 755e5c1..0ec09e6 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2017 olOwOlo
+Copyright (c) 2017 xianmin
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in
diff --git a/README-zh.md b/README-zh.md
index 12b50ba..830b435 100644
--- a/README-zh.md
+++ b/README-zh.md
@@ -1 +1,20 @@
-# hugo-theme-jane
\ No newline at end of file
+![jane-preview](https://raw.githubusercontent.com/xianmin/hugo-theme-jane/master/images/preview.png)
+
+
+## hugo-theme-jane
+
+Jane 是一个专注于阅读体验的 Hugo 主题。最早的版本基于 [hugo-theme-even](https://github.com/olOwOlo/hugo-theme-even) ，在它的基础上进行了重新改造。
+
+[Demo](http://en.xianmin.org/hugo-theme-jane/) | [我的博客](http://www.xianmin.org)
+
+
+## 如何使用？
+
+### 安装 hugo
+最简单的方法，从 [Releases · gohugoio/hugo](https://github.com/gohugoio/hugo/releases) 直接下载对应的安装包进行安装。
+
+或者参考： [[https://gohugo.io/getting-started/installing/][Install Hugo | Hugo]]
+
+### 直接使用 Jane 搭建
+
+
diff --git a/README.md b/README.md
index 12b50ba..bc096b2 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,153 @@
-# hugo-theme-jane
\ No newline at end of file
+![jane-preview](https://raw.githubusercontent.com/xianmin/hugo-theme-jane/master/images/preview.png)
+
+## hugo-theme-jane
+
+Jane is a readable theme for Hugo. It's a fork of the [hugo-theme-even](https://github.com/olOwOlo/hugo-theme-even) and made a lot of changes.
+
+[Demo](http://en.xianmin.org/hugo-theme-jane/) | [My blog](http://www.xianmin.org) | [中文说明](https://github.com/xianmin/hugo-theme-jane/blob/master/README-zh.md)
+
+This theme focuses on improving reading experience.
+
+
+## Getting Started
+
+Clone this repository to your hugo theme directory.
+
+```bash
+mkdir themes
+cd themes
+git clone https://github.com/xianmin/hugo-theme-jane.git
+```
+
+## Site Configuration
+
+Take a look in the [exampleSite](https://github.com/xianmin/hugo-theme-jane/tree/master/exampleSite) folder.
+
+This directory contains an example config file and the content for the demo.
+It serves as an example setup for your documentation.
+
+Copy the `config.toml` in the root directory of your website. Overwrite the existing config file if necessary.
+
+__[config.toml](https://github.com/xianmin/hugo-theme-jane/blob/master/exampleSite/config.toml)__:
+
+```toml
+baseURL = "http://localhost:1313/"
+title = "Jane - A super concise theme for Hugo"
+enableRobotsTXT = true
+enableEmoji = true
+theme = "jane"
+
+# language support # en / zh-cn / other...
+defaultContentLanguage = "en"
+[Languages.en]
+  languageCode = "en"
+
+hasCJKLanguage = true     # has chinese/japanese/korean ? # 自动检测是否包含 中文\日文\韩文
+paginate = 3                                              # 首页每页显示的文章数
+disqusShortname = ""      # disqus_shortname
+googleAnalytics = ""      # UA-XXXXXXXX-X
+copyright = ""            # default: author.name ↓        # 默认为下面配置的author.name ↓
+
+[author]                  # essential                     # 必需
+  name = "xianmin"
+
+[sitemap]                 # essential                     # 必需
+  changefreq = "weekly"
+  priority = 0.5
+  filename = "sitemap.xml"
+
+[[menu.main]]             # config your menu              # 配置目录
+  name = "Home"
+  weight = 10
+  identifier = "home"
+  url = "/"
+[[menu.main]]
+  name = "Archives"
+  weight = 20
+  identifier = "archives"
+  url = "/post/"
+[[menu.main]]
+  name = "Tags"
+  weight = 30
+  identifier = "tags"
+  url = "/tags/"
+[[menu.main]]
+  name = "Categories"
+  weight = 40
+  identifier = "categories"
+  url = "/categories/"
+
+[params]
+  debug = false             # If true, load `eruda.min.js`. See https://github.com/liriliri/eruda
+
+  since = "2017"            # Site creation time          # 站点建立时间
+
+  # site info (optional)                                  # 站点信息（可选，不需要的可以直接注释掉）
+  logoTitle = "Jane"        # default: the title value    # 默认值: 上面设置的title值
+  keywords = ["Hugo", "theme","jane"]
+  description = "Hugo theme jane example site."
+
+  # paginate of archives, tags and categories             # 归档、标签、分类每页显示的文章数目，建议修改为一个较大的值
+  archive-paginate = 3
+
+  # The date format to use; for a list of valid formats, see https://gohugo.io/functions/format/
+  dateFormatToUse = "2006-01-02"
+
+  # show word count and read time ?                       # 是否显示字数统计与阅读时间
+  moreMeta = true
+
+  # 一些全局开关，你也可以在每一篇内容的 front matter 中针对单篇内容关闭或开启某些功能，在 archetypes/default.md 查看更多信息。
+  # Some global options, you can also close or open something in front matter for a single post, see more information from `archetypes/default.md`.
+  toc = true                                                                            # 是否开启目录
+  autoCollapseToc = false   # Auto expand and collapse toc                              # 目录自动展开/折叠
+  fancybox = true           # see https://github.com/fancyapps/fancybox                 # 是否启用fancybox（图片可点击）
+  bootcdn = false           # In china. @Deprecated: use [params.publicCDN]             # 是否使用bootcdn(@Deprecated: 请使用[params.publicCDN])
+  mathjax = false           # see https://www.mathjax.org/                              # 是否使用mathjax（数学公式）
+  contentCopyright = '<a rel="license noopener" href="https://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank">CC BY-NC-ND 4.0</a>'
+
+  changyanAppid = ""        # Changyan app id             # 畅言
+  changyanAppkey = ""       # Changyan app key
+  baidu_push = false        # baidu push                  # 百度
+  baidu_analytics = ""      # Baidu Analytics
+  baidu_verification = ""   # Baidu Verification
+  google_verification = ""  # Google_Verification         # 谷歌
+
+  [params.publicCDN]        # load these files from public cdn                          # 启用公共CDN，需自行定义
+    enable = false
+    jquery = '<script src="https://cdn.jsdelivr.net/npm/jquery@3.2.1/dist/jquery.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4=" crossorigin="anonymous"></script>'
+    slideout = '<script src="https://cdn.jsdelivr.net/npm/slideout@1.0.1/dist/slideout.min.js" integrity="sha256-t+zJ/g8/KXIJMjSVQdnibt4dlaDxc9zXr/9oNPeWqdg=" crossorigin="anonymous"></script>'
+    fancyboxJs = '<script src="https://cdn.jsdelivr.net/npm/@fancyapps/fancybox@3.1.20/dist/jquery.fancybox.min.js" integrity="sha256-XVLffZaxoWfGUEbdzuLi7pwaUJv1cecsQJQqGLe7axY=" crossorigin="anonymous"></script>'
+    fancyboxCss = '<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@fancyapps/fancybox@3.1.20/dist/jquery.fancybox.min.css" integrity="sha256-7TyXnr2YU040zfSP+rEcz29ggW4j56/ujTPwjMzyqFY=" crossorigin="anonymous">'
+
+  [params.reward]                                         # 文章打赏
+    enable = false
+    wechat = "/path/to/your/wechat-qr-code.png"           # 微信二维码
+    alipay = "/path/to/your/alipay-qr-code.png"           # 支付宝二维码
+
+  [params.social]                                         # 社交链接
+    a-email = "mailto:your@email.com"
+    b-stack-overflow = "http://localhost:1313"
+    c-twitter = "http://localhost:1313"
+    d-facebook = "http://localhost:1313"
+    e-linkedin = "http://localhost:1313"
+    f-google = "http://localhost:1313"
+    g-github = "http://localhost:1313"
+    h-weibo = "http://localhost:1313"
+    i-zhihu = "http://localhost:1313"
+    j-douban = "http://localhost:1313"
+    k-pocket = "http://localhost:1313"
+    l-tumblr = "http://localhost:1313"
+    m-instagram = "http://localhost:1313"
+```
+
+## Build
+
+```
+hugo server
+```
+
+You can go to localhost:1313 and this theme should be visible.
+
+## License
+
+Hugo-theme-jane is licensed under the MIT license. Check the [LICENSE](LICENSE.md) file for details.
\ No newline at end of file
diff --git a/config.toml b/config.toml
index c2787ee..fe858b6 100644
--- a/config.toml
+++ b/config.toml
@@ -1,12 +1,13 @@
 baseURL = "http://en.xianmin.org/hugo-theme-jane/"
-defaultContentLanguage = "zh-CN"
 title = "Jane - A simple theme for Hugo"
 enableRobotsTXT = true
 enableEmoji = true
 # theme = "jane"
 
+# language support # en / zh-cn / other...
+defaultContentLanguage = "en"
 [Languages.en]
-  languageCode = "en"  # language to use  # 使用中文改成 zh.CN
+  languageCode = "en"
 
 hasCJKLanguage = true     # has chinese/japanese/korean ? # 自动检测是否包含 中文\日文\韩文
 paginate = 5                                              # 首页每页显示的文章数
diff --git a/exampleSite/config.toml b/exampleSite/config.toml
index e9de8c3..fc70ce6 100644
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@@ -1,11 +1,14 @@
 baseURL = "http://localhost:1313/"
-languageCode = "en"
-defaultContentLanguage = "en"
 title = "Jane - A super concise theme for Hugo"
 enableRobotsTXT = true
 enableEmoji = true
 theme = "jane"
 
+# language support # en / zh-cn / other...
+defaultContentLanguage = "en"
+[Languages.en]
+  languageCode = "en"
+
 hasCJKLanguage = true     # has chinese/japanese/korean ? # 自动检测是否包含 中文\日文\韩文
 paginate = 3                                              # 首页每页显示的文章数
 disqusShortname = ""      # disqus_shortname
@@ -13,7 +16,7 @@ googleAnalytics = ""      # UA-XXXXXXXX-X
 copyright = ""            # default: author.name ↓        # 默认为下面配置的author.name ↓
 
 [author]                  # essential                     # 必需
-  name = "olOwOlo"
+  name = "xianmin"
 
 [sitemap]                 # essential                     # 必需
   changefreq = "weekly"
@@ -58,7 +61,7 @@ copyright = ""            # default: author.name ↓        # 默认为下面配
   dateFormatToUse = "2006-01-02"
 
   # show word count and read time ?                       # 是否显示字数统计与阅读时间
-  moreMeta = false
+  moreMeta = true
 
   # 一些全局开关，你也可以在每一篇内容的 front matter 中针对单篇内容关闭或开启某些功能，在 archetypes/default.md 查看更多信息。
   # Some global options, you can also close or open something in front matter for a single post, see more information from `archetypes/default.md`.
@@ -67,8 +70,6 @@ copyright = ""            # default: author.name ↓        # 默认为下面配
   fancybox = true           # see https://github.com/fancyapps/fancybox                 # 是否启用fancybox（图片可点击）
   bootcdn = false           # In china. @Deprecated: use [params.publicCDN]             # 是否使用bootcdn(@Deprecated: 请使用[params.publicCDN])
   mathjax = false           # see https://www.mathjax.org/                              # 是否使用mathjax（数学公式）
-  linkToMarkDown = false    # if you config contentCopyright and hugo output .md files. # 是否在链接到markdown原始文件（如果你配置了下面的许可协议并允许hugo生成markdown文件）
-
   contentCopyright = '<a rel="license noopener" href="https://creativecommons.org/licenses/by-nc-nd/4.0/" target="_blank">CC BY-NC-ND 4.0</a>'
 
   changyanAppid = ""        # Changyan app id             # 畅言
@@ -104,21 +105,3 @@ copyright = ""            # default: author.name ↓        # 默认为下面配
     k-pocket = "http://localhost:1313"
     l-tumblr = "http://localhost:1313"
     m-instagram = "http://localhost:1313"
-
-# 将下面这段配置取消注释可以使 hugo 生成 .md 文件
-# Uncomment these options to make hugo output .md files.
-#[mediaTypes]
-#  [mediaTypes."text/plain"]
-#    suffix = "md"
-#
-#[outputFormats.MarkDown]
-#  mediaType = "text/plain"
-#  isPlainText = true
-#  isHTML = false
-#
-#[outputs]
-#  home = ["HTML", "RSS"]
-#  page = ["HTML", "MarkDown"]
-#  section = ["HTML", "RSS"]
-#  taxonomy = ["HTML", "RSS"]
-#  taxonomyTerm = ["HTML"]
diff --git a/exampleSite/content/post/jane-theme-preview.md b/exampleSite/content/post/jane-theme-preview.md
new file mode 100644
index 0000000..e771b4d
--- /dev/null
+++ b/exampleSite/content/post/jane-theme-preview.md
@@ -0,0 +1,339 @@
+---
+title: "Jane Theme Preview"
+date: 2018-03-06T16:01:23+08:00
+lastmod: 2018-03-07T16:01:23+08:00
+draft: false
+tags: ["preview", "shortcodes", "tag-6"]
+categories: ["shortcodes", "index"]
+author: "Typora"
+
+# You can also close(false) or open(true) something for this content.
+# P.S. comment can only be closed
+# comment: false
+# toc: false
+
+# You can also define another contentCopyright. e.g. contentCopyright: "This is another copyright."
+contentCopyright: '<a href="https://github.com/gohugoio/hugoBasicExample" rel="noopener" target="_blank">See origin</a>'
+# reward: false
+mathjax: true
+---
+
+**Markdown** is created by [Daring Fireball](http://daringfireball.net/), the original guideline is [here](http://daringfireball.net/projects/markdown/syntax). Its syntax, however, varies between different parsers or editors. 
+
+Please note that HTML fragments in markdown source will be recognized but not parsed or rendered. Also, there may be small reformatting on the original markdown source code after saving.
+
+<!--more-->
+
+## Paragraph and line breaks
+
+A paragraph is simply one or more consecutive lines of text. In markdown source code, paragraphs are separated by more than one blank lines. In Typora, you only need to press `Return` to create a new paragraph.
+
+Press `Shift` + `Return` to create a single line break. However, most markdown parser will ignore single line break, to make other markdown parsers recognize your line break, you can leave two whitespace at the end of the line, or insert `<br/>`.
+
+## Headers
+
+Headers use 1-6 hash characters at the start of the line, corresponding to header levels 1-6. For example:
+
+``` markdown
+# This is an H1
+
+## This is an H2
+
+###### This is an H6
+```
+
+In typora, input ‘#’s followed by title content, and press `Return` key will create a header.
+
+## Blockquotes
+
+Markdown uses email-style > characters for block quoting. They are presented as:
+
+
+> This is a blockquote with two paragraphs. This is first paragraph.
+>
+> This is second pragraph.Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
+
+
+
+> This is another blockquote with one paragraph. There is three empty line to seperate two blockquote.
+
+
+In typora, just input ‘>’ followed by quote contents a block quote is  generated. Typora will insert proper ‘>’ or line break for you. Block quote inside anther block quote is allowed by adding additional levels of ‘>’. 
+
+## Lists
+
+Input `* list item 1` will create an un-ordered list, the `*` symbol can be replace with `+` or `-`. 
+
+Input `1. list item 1` will create an ordered list, their markdown source code is like:
+
+*   Red
+*   Green
+*   Blue
+
+1.  Red
+2. 	Green
+3.	Blue
+
+
+## Task List
+
+Task lists are lists with items marked as either [ ] or [x] (incomplete or complete). For example:
+
+- [ ] a task list item
+- [ ] list syntax required
+- [ ] normal **formatting**, @mentions, #1234 refs
+- [ ] incomplete
+- [x] completed
+
+You can change the complete/incomplete state by click the checkbox before the item.
+
+## Syntax Highlighting
+
+```js
+function helloWorld () {
+  alert("Hello, World!")
+}
+```
+
+```java
+public class HelloWorld {
+  public static void main(String[] args) {
+    System.out.println("Hello, World!");
+  }
+}
+```
+
+## Math Blocks
+
+You can render *LaTeX* mathematical expressions using **MathJax**.
+
+Input `$$`, then press 'Return' key will trigger an input field which accept *Tex/LaTex* source. Following is an example:
+$$
+\mathbf{V}_1 \times \mathbf{V}_2 =  \begin{vmatrix} 
+\mathbf{i} & \mathbf{j} & \mathbf{k} \\
+\frac{\partial X}{\partial u} &  \frac{\partial Y}{\partial u} & 0 \\
+\frac{\partial X}{\partial v} &  \frac{\partial Y}{\partial v} & 0 \\
+\end{vmatrix}
+$$
+
+
+In markdown source file, math block is *LaTeX* expression wrapped by ‘$$’ mark:
+
+``` markdown
+$$
+\mathbf{V}_1 \times \mathbf{V}_2 =  \begin{vmatrix} 
+\mathbf{i} & \mathbf{j} & \mathbf{k} \\
+\frac{\partial X}{\partial u} &  \frac{\partial Y}{\partial u} & 0 \\
+\frac{\partial X}{\partial v} &  \frac{\partial Y}{\partial v} & 0 \\
+\end{vmatrix}
+$$
+```
+
+## Tables
+
+Input `| First Header  | Second Header |` and press `return` key will create a table with two column.
+
+After table is created, focus on that table will pop up a toolbar for table, where you can resize, align, or delete table. You can also use context menu to copy and add/delete column/row.
+
+Following descriptions can be skipped, as markdown source code for tables are generated by typora automatically.
+
+In markdown source code, they look like:
+
+``` markdown
+| First Header  | Second Header |
+| ------------- | ------------- |
+| Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  |
+```
+
+| First Header  | Second Header |
+| ------------- | ------------- |
+| Content Cell  | Content Cell  |
+| Content Cell  | Content Cell  |
+
+
+## Footnotes
+
+``` markdown
+You can create footnotes like this[^footnote].
+
+[^footnote]: Here is the *text* of the **footnote**.
+```
+
+will produce:
+
+You can create footnotes like this[^footnote].
+
+[^footnote]: Here is the *text* of the **footnote**.
+
+Mouse on the ‘footnote’ superscript to see content of the footnote.
+
+## Horizontal Rules
+
+Input `***` or `---` on a blank line and press `return` will draw a horizontal line.
+
+------
+
+## Links
+
+Markdown supports two style of links: inline and reference.
+
+In both styles, the link text is delimited by [square brackets].
+
+To create an inline link, use a set of regular parentheses immediately after the link text’s closing square bracket. Inside the parentheses, put the URL where you want the link to point, along with an optional title for the link, surrounded in quotes. For example:
+
+``` markdown
+This is [an example](http://example.com/ "Title") inline link.
+
+[This link](http://example.net/) has no title attribute.
+```
+
+will produce:
+
+This is [an example](http://example.com/"Title") inline link. (`<p>This is <a href="http://example.com/" title="Title">`)
+
+[This link](http://example.net/) has no title attribute. (`<p><a href="http://example.net/">This link</a> has no`)
+
+### Internal Links
+
+**You can set the href to headers**, which will create a bookmark that allow you to jump to that section after clicking. For example:
+
+Command(on Windows: Ctrl) + Click [This link](#block-elements) will jump to header `Block Elements`. To see how to write that, please move cursor or click that link with `⌘` key pressed to expand the element into markdown source.
+
+### Reference Links 
+
+Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:
+
+``` markdown
+This is [an example][id] reference-style link.
+
+Then, anywhere in the document, you define your link label like this, on a line by itself:
+
+[id]: http://example.com/  "Optional Title Here"
+```
+
+In typora, they will be rendered like:
+
+This is [an example][id] reference-style link.
+
+[id]: http://example.com/	"Optional Title Here"
+
+The implicit link name shortcut allows you to omit the name of the link, in which case the link text itself is used as the name. Just use an empty set of square brackets — e.g., to link the word “Google” to the google.com web site, you could simply write:
+
+``` markdown
+[Google][]
+And then define the link:
+
+[Google]: http://google.com/
+```
+
+In typora click link will expand it for editing, command+click will open the hyperlink in web browser.
+
+## URLs
+
+Typora allows you to insert urls as links, wrapped by `<`brackets`>`.
+
+`<i@typora.io>` becomes <i@typora.io>.
+
+Typora will aslo auto link standard URLs. e.g: www.google.com.
+
+## Images
+
+Image looks similar with links, but it requires an additional `!` char before the start of link. Image syntax looks like this:
+
+``` markdown
+![Alt text](/path/to/img.jpg)
+
+![Alt text](/path/to/img.jpg "Optional title")
+```
+
+You are able to use drag & drop to insert image from image file or we browser. And modify the markdown source code by clicking on the image. Relative path will be used if image is in same directory or sub-directory with current editing document when drag & drop.
+
+For more tips on images, please read <http://support.typora.io//Images/>
+
+## Emphasis
+
+Markdown treats asterisks (`*`) and underscores (`_`) as indicators of emphasis. Text wrapped with one `*` or `_` will be wrapped with an HTML `<em>` tag. E.g:
+
+``` markdown
+*single asterisks*
+
+_single underscores_
+```
+
+output: 
+
+*single asterisks*
+
+_single underscores_
+
+GFM will ignores underscores in words, which is commonly used in code and names, like this:
+
+> wow_great_stuff
+>
+> do_this_and_do_that_and_another_thing.
+
+To produce a literal asterisk or underscore at a position where it would otherwise be used as an emphasis delimiter, you can backslash escape it:
+
+``` markdown
+\*this text is surrounded by literal asterisks\*
+```
+
+Typora recommends to use `*` symbol.
+
+## Strong
+
+double *’s or _’s will be wrapped with an HTML `<strong>` tag, e.g:
+
+``` markdown
+**double asterisks**
+
+__double underscores__
+```
+
+output:
+
+**double asterisks**
+
+__double underscores__
+
+Typora recommends to use `**` symbol.
+
+## Code
+
+To indicate a span of code, wrap it with backtick quotes (`). Unlike a pre-formatted code block, a code span indicates code within a normal paragraph. For example:
+
+``` markdown
+Use the `printf()` function.
+```
+
+will produce:
+
+Use the `printf()` function.
+
+## Strikethrough
+
+GFM adds syntax to create strikethrough text, which is missing from standard Markdown.
+
+`~~Mistaken text.~~` becomes ~~Mistaken text.~~
+
+## Underline
+
+Underline is powered by raw HTML.
+
+`<u>Underline</u>` becomes <u>Underline</u>.
+
+## Emoji :happy:
+
+Input emoji with syntax `:smile:`. 
+
+User can trigger auto-complete suggestions for emoji by pressing `ESC` key, or trigger it automatically after enable it on preference panel. Also, input UTF8 emoji char directly from `Edit` -> `Emoji & Symbols` from menu bar is also supported. 
+
+
+## Inline Math
+
+To use this feature, first, please enable it in `Preference` Panel -> `Markdown` Tab. Then use `$` to wrap TeX command, for example: `$\lim_{x \to \infty} \exp(-x) = 0$` will be rendered as LaTeX command. 
+
+To trigger inline preview for inline math: input “$”, then press `ESC` key, then input TeX command, a preview tooltip will be visible like below:
+
+<img src="http://typora.io/img/inline-math.gif" style="zoom:50%;" />
diff --git a/images/preview.png b/images/preview.png
new file mode 100644
index 0000000..cbcd6eb
--- /dev/null
+++ b/images/preview.png
diff --git a/images/screenshot.png b/images/screenshot.png
index 2b81704..3869b00 100644
--- a/images/screenshot.png
+++ b/images/screenshot.png
diff --git a/images/tn.png b/images/tn.png
new file mode 100644
index 0000000..9e4cb2d
--- /dev/null
+++ b/images/tn.png