README.md · Gitee 极速下载/ZenHo

## Languange

English | [中文](README_ZH.md)

## What

**ZenHo** is a pretty simple & nice theme for [Hugo](https://gohugo.io/)

> All good things come to thos who wait.

![screenshot](images/screenshot.png)

### Features TODO

- [ ] Disqus comment
- [ ] Google Analytics
- [x] Baidu Analytics
- [x] Table of Content
- [x] Social  list
- [x] Utteranc comment
- [x] shortcode: github project card

## How to use

Step 1 :

If you know  [Hugo](https://gohugo.io/) for the first time,you need to learn  [official tutorial](https://gohugo.io/getting-started/quick-start/) first.

Step 2 :

you can use  `hugo-zenHo/archetypes/default.md`  replace your blog's `archetypes/default.md` `

Step 3 :

If you want to custon your **about page**, you should create markdown file `content/about/_index.md`, then write it in markdown syntax.

Step 4:

Copy [Configuration Override](##Configuration Override) content to your config.toml，for better highlight, you can use `xcode` style

```toml	
[markup]
  [markup.highlight]
    style = "xcode"
```

More info could be found at **exampleSite** directory.

## Github project card

ZenHo use shortCode and [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) to implement Github Project card.

![github-project-card](release/img/github-project.png)

you can use the following code to show card in post

```html
{{< github-project username="your github user name" repo="your github project name" >}}
```

such as

```html
{{< github-project username="vran-dev" repo="hugo-zenHo" >}}
```

## Configuration Override

You can copy some item to your `config.toml` .

```toml
baseURL = "http://localhost:1313/"
languageCode = "en-us"
title = "ZenHo"
paginate = 6

[params]
    enableSummary = true
    useDescriptionReplaceSummary = true
    enableToc = false

author  = "vran"
    bio = "All good things come to thos who wait."

# baidu analytics
    enableBaiduAnalytics = false
    baiduAnalyticsToken = ""

googleSiteVerificationToken = ""

# social page url
    github = "#"
    twitter = "#"
    facebook = "#"
    email = ""

# utteranc comment
    enableUtteranc = false
    [params.utteranc]
        repo="username/github-page-repository"
        theme="github-light"
        crossorigin="anonymous"
        issueTerm="pathname"
        label="Comment"

[markup]
  [markup.highlight]
    style = "xcode"
  [markup.tableOfContents]
    endLevel = 2
    ordered = false
    startLevel = 2
```

## Screenshots

- Home

![](release/img/home.png)

- post

![](release/img/post.png)

![](release/img/content-2.jpg)

- Archive

![](release/img/archive.jpg)

- tags

![](release/img/tags.jpg)

- About

![](release/img/about.png)

Gitee 极速下载/ZenHo

简介

发行版

贡献者

近期动态

Gitee 极速下载/ZenHo .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

Gitee 极速下载/ZenHo