docs: update features, configuration and how_to_release

hansyao · Oct 21, 2018 · 7e5c8b1 · 7e5c8b1
1 parent ceb829a
commit 7e5c8b1
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 35 deletions.
diff --git a/HOW_TO_RELEASE.md b/HOW_TO_RELEASE.md
@@ -15,5 +15,5 @@
 - run `npm run gem-push` to publish gem to rubygems.org
 - run `git add . && git commit -m  "release: vx.x.x"` to make a release commit
 - run `git tag vx.x.x` to add a tag
-- run `git push && git push --tags` to push
+- run `git push && git push origin vx.x.x` to push
 - edit release on github.com
diff --git a/README-zh.md b/README-zh.md
@@ -15,22 +15,21 @@ TeXt 是针对个人或团队网站、博客、项目、文档等的一款高度
 ## Features
 
 - 响应式
+- HTML 语意化
 - 皮肤
 - 代码高亮主题
-- 目录
-- 多作者
 - 多语言支持
 - 搜索
-- Web 语意化
-- RSS（[jekyll-feed](https://github.com/jekyll/jekyll-feed)）
-- 联系方式设置（Email, Facebook, Twitter, 微博, 知乎……）
-- 数学公式（[MathJax](https://www.mathjax.org/)）
-- 流程图， 序列图，甘特图（[mermaid](https://mermaidjs.github.io/)）
-- 柱状图，折线图，饼图，雷达图（[chartjs](http://www.chartjs.org/)）
-- 阅读次数统计（[LeanCloud](https://leancloud.cn/)）
+- 目录
+- 作者（电子邮件，Facebook，Twitter，领英，微博，知乎等。支持多作者配置）
+- 附加样式（提示，标签，图片，图标，按钮，栅格等）
+- 扩展（音频，视频，幻灯片）
+- Markdown 增强（[MathJax](https://www.mathjax.org/)，[mermaid](https://mermaidjs.github.io/)，[chartjs](http://www.chartjs.org/)）
 - 分享（[AddToAny](https://www.addtoany.com/)）
 - 评论（[Disqus](https://disqus.com/), [gitalk](https://gitalk.github.io/)）
-- Google Analytics
+- 阅读量统计（[LeanCloud](https://leancloud.cn/)）
+- 站点统计（Google Analytics）
+- RSS（[jekyll-feed](https://github.com/jekyll/jekyll-feed)）
 
 ## 皮肤
 

diff --git a/README.md b/README.md
@@ -15,22 +15,21 @@ TeXt is a super customizable Jekyll theme for personal site, team site, blog, pr
 ## Features
 
 - Responsive
+- Semantic HTML
 - Skins
 - Highlight Theme
-- Table of contents
-- Authors
 - Multi-language support
 - Search
-- Semantic HTML
-- RSS（[jekyll-feed](https://github.com/jekyll/jekyll-feed))
-- Contact information (Email, Facebook, Twitter, Linkedin, Weibo, Zhihu, etc)
-- Mathematical formula ([MathJax](https://www.mathjax.org/))
-- Flowchart, Sequence diagram, Gantt diagram ([mermaid](https://mermaidjs.github.io/))
-- Line Chart, Bar Chart, Radar Chart, Pie Chart ([chartjs](http://www.chartjs.org/))
-- Page views ([LeanCloud](https://leancloud.cn/))
-- Share ([AddToAny](https://www.addtoany.com/))
+- Table of contents
+- Authors (Email, Facebook, Twitter, Linkedin, Weibo, Zhihu, etc)
+- Additional styles (alert, tag, image, icon, button, grid, etc)
+- Extensions (audios, videos, slides)
+- Markdown enhancements ([MathJax](https://www.mathjax.org/), [mermaid](https://mermaidjs.github.io/), [chartjs](http://www.chartjs.org/))
+- Sharing ([AddToAny](https://www.addtoany.com/))
 - Comments ([Disqus](https://disqus.com/))
-- Google Analytics
+- Pageview ([LeanCloud](https://leancloud.cn/))
+- Analytics (Google Analytics)
+- RSS ([jekyll-feed](https://github.com/jekyll/jekyll-feed))
 
 ## Skins
 

diff --git a/about.md b/about.md
@@ -19,22 +19,21 @@ TeXt is a super customizable Jekyll theme for personal site, team site, blog, pr
 ## Features
 
 - Responsive
+- Semantic HTML
 - Skins
 - Highlight Theme
-- Table of contents
-- Authors
 - Multi-language support
 - Search
-- Semantic HTML
-- RSS（[jekyll-feed](https://github.com/jekyll/jekyll-feed))
-- Contact information (Email, Facebook, Twitter, Linkedin, Weibo, Zhihu, etc)
-- Mathematical formula ([MathJax](https://www.mathjax.org/))
-- Flowchart, Sequence diagram, Gantt diagram ([mermaid](https://mermaidjs.github.io/))
-- Line Chart, Bar Chart, Radar Chart, Pie Chart ([chartjs](http://www.chartjs.org/))
-- Page views ([LeanCloud](https://leancloud.cn/))
-- Share ([AddToAny](https://www.addtoany.com/))
+- Table of contents
+- Authors (Email, Facebook, Twitter, Linkedin, Weibo, Zhihu, etc)
+- Additional styles (alert, tag, image, icon, button, grid, etc)
+- Extensions (audios, videos, slides)
+- Markdown enhancements ([MathJax](https://www.mathjax.org/), [mermaid](https://mermaidjs.github.io/), [chartjs](http://www.chartjs.org/))
+- Sharing ([AddToAny](https://www.addtoany.com/))
 - Comments ([Disqus](https://disqus.com/))
-- Google Analytics
+- Pageview ([LeanCloud](https://leancloud.cn/))
+- Analytics (Google Analytics)
+- RSS ([jekyll-feed](https://github.com/jekyll/jekyll-feed))
 
 ## Skins
 

diff --git a/docs/_docs/en/2.1-configuration.md b/docs/_docs/en/2.1-configuration.md
@@ -306,11 +306,11 @@ For all the above comments systems, you NEED set `key` variable in the page’s
 | --- | --- |
 | **leancloud** | [Disqus](https://leancloud.cn/) |
 
-## LeanCloud
+### LeanCloud
 
 This use [LeanCloud](https://leancloud.cn/) as back-end service. You need create a app on the dashboard, and config the app’s id, key and class name.
 
-The detail guide of LeanCloud will find in [Chinese document](https://tianqi.name/jekyll-TeXt-theme/docs/zh/configuration#%E6%96%87%E7%AB%A0%E7%82%B9%E5%87%BB%E9%87%8F) since LeanCloud haven't provide an English-language edition.
+The detail guide of LeanCloud will find in [Chinese document](https://tianqi.name/jekyll-TeXt-theme/docs/zh/configuration#leancloud) since LeanCloud haven't provide an English-language edition.
 {:.info}
 
 ```yaml

diff --git a/docs/_docs/zh/2.1-configuration.md b/docs/_docs/zh/2.1-configuration.md
@@ -304,6 +304,8 @@ comments:
 | --- | --- |
 | **leancloud** | [Disqus](https://leancloud.cn/) |
 
+### LeanCloud
+
 TeXt 使用 LeanCloud 作为点击量功能的后台服务。你需要建立一个应用，然后在应用中建立一个 Class，之后将必要的信息填写到 *_config.yml* 文件中。下面详细介绍其操作步骤。
 
 在进入[主页](https://leancloud.cn/)后点击页面右上角的“访问控制台”，然后注册账号并登录。