diff --git a/README.md b/README.md index e523a6c..1c63605 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,29 @@ -# Cactus Plus + + +- [Cactus Plus](#cactus-plus) + - [Screenshot](#screenshot) + - [Installation](#installation) + - [Example Site](#example-site) + - [The config file](#the-config-file) + - [About page](#about-page) + - [Tags page](#tags-page) + - [Avatar](#avatar) + - [Hide pages](#hide-pages) + - [Disqus](#disqus) + - [Duoshuo](#duoshuo) + - [Disable Comment](#disable-comment) + - [Google Analytics](#google-analytics) + - [Baidu Tongji](#baidu-tongji) + - [Social link icons](#social-link-icons) + - [Nearly finished](#nearly-finished) + - [License](#license) + - [Acknowledgements](#acknowledgements) + + +# Cactus Plus -[English Documention](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/README.md) | [中文文档](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/README_zh-cn.md) +[English Document](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/README.md) | [中文文档](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/README_zh-cn.md) Cactus Plus is a minimalistic theme for bloggers based on the theme named [Cactus](https://github.com/digitalcraftsman/hugo-cactus-theme). @@ -43,7 +65,7 @@ For more information read the official [setup guide](//gohugo.io/overview/instal There is an example site with config file and markdown files in [`exampleSite`](https://github.com/nodejh/hugo-theme-cactus-plus/tree/master/exampleSite) directory. -### The config file +## The config file Take a look inside the [`exampleSite`](https://github.com/nodejh/hugo-theme-cactus-plus/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/exampleSite/config.toml). @@ -53,6 +75,20 @@ To use it, copy the [`config.toml`](https://github.com/nodejh/hugo-theme-cactus- Use the about page to introduce yourself to your visitors. You can customize the content as you like in the `/content/about/index.md`. +## Tags page + +Use the tags page to show all post's tags. You can create the file `/content/tags/index.md` and set `hidden = true`. + +For example: + +```markdown ++++ +date = "2015-06-20T14:02:37+02:00" +title = "Tags" +hidden = true ++++ +``` + ## Avatar Furthermore, you should replace the [avatar placeholder](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/static/images/) with a great image of yourself. diff --git a/README_zh-cn.md b/README_zh-cn.md index 2dc7b2c..fa529e0 100644 --- a/README_zh-cn.md +++ b/README_zh-cn.md @@ -1,3 +1,26 @@ + + +- [Cactus Plus](#cactus-plus) + - [截图](#截图) + - [安装](#安装) + - [示例站点](#示例站点) + - [配置文件](#配置文件) + - [关于页面](#关于页面) + - [标签页](#标签页) + - [头像](#头像) + - [隐藏页面](#隐藏页面) + - [Disqus 评论](#disqus-评论) + - [多说评论](#多说评论) + - [不使用评论系统](#不使用评论系统) + - [Google Analytics](#google-analytics) + - [百度统计](#百度统计) + - [社交链接](#社交链接) + - [部署主题](#部署主题) + - [License](#license) + - [鸣谢](#鸣谢) + + + # Cactus Plus @@ -44,7 +67,7 @@ $ git clone https://github.com/nodejh/hugo-theme-cactus-plus.git [`exampleSite`](https://github.com/nodejh/hugo-theme-cactus-plus/tree/master/exampleSite) 是本主题的一个示例站点,里面有配置文件、关于页面的一些示例。 -### 配置文件 +## 配置文件 本主题提供了一个示例配置文件是 [`exampleSite`](https://github.com/nodejh/hugo-theme-cactus-plus/tree/master/exampleSite) 目录里的 [`config.toml`](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/exampleSite/config.toml) 文件。 @@ -57,6 +80,19 @@ $ git clone https://github.com/nodejh/hugo-theme-cactus-plus.git 你也可以参考本主题示例站点中的关于页:[`exampleSite/content/about/index.md`](https://github.com/nodejh/hugo-theme-cactus-plus/blob/master/exampleSite/content/about/index.md)。 +## 标签页 + +本主题也提供了 `标签页` 功能。 + +在 `content` 目录下新建一个名为 `tags` 的目录,然后在次目录创建一个名为 `index.md` 的文件,写入下面的内容,注意设置 `hidden = true` 即可: + +```markdown ++++ +date = "2015-06-20T14:02:37+02:00" +title = "Tags" +hidden = true ++++ +``` ## 头像