Skip to content

Commit

Permalink
feat: add document
Browse files Browse the repository at this point in the history
  • Loading branch information
guangzhengli committed Aug 19, 2022
1 parent b1b76bc commit 9576b06
Show file tree
Hide file tree
Showing 8 changed files with 550 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,13 @@ Demo is built up with [exampleSite Source Code](https://github.com/guangzhengli/

---

## Documentations [`docs`](docs/home.md)

See [`docs`](docs/home.md) folder.

## Quick Start

Just click `Use this template` to create your blog site in the [exampleSite Source Code](https://github.com/guangzhengli/hugo-ladder-exampleSite).
Just click `Use this template` to create your blog site in the [exampleSite Repository](https://github.com/guangzhengli/hugo-ladder-exampleSite).

Create a new repository(GitHub Pages) from hugo-ladder-exampleSite to enter : `username.github.io`.

Expand Down
30 changes: 30 additions & 0 deletions docs/analytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
### Analytics

#### Google Analytics

Follow [these steps](https://gohugo.io/templates/internal/#configure-google-analytics).

#### Google Tag Manager

Follow [these steps](https://developers.google.com/tag-manager).

```yml
params:
analytics:
google:
SiteVerificationTag: gid
```

#### Umami Analytics

Follow [these steps](https://guangzhengli.com/blog/en/how-to-integrate-umami-for-free-to-blog-site/).

```yml
params:
analytics:
umami:
enable: true
website_id: data-website-id
url: https://umami-ochre-nu.vercel.app/hugo-ladder.js
```
36 changes: 36 additions & 0 deletions docs/comment-system.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
### Comment Systems

Comments are displayed within post pages and guestbook.

#### Giscus

Follow [these steps](https://giscus.app/).

```yml
params:
comments:
giscus:
enable: true
repo: username/reponame
repo_id: Rid
category: Announcements
category_id: DIC_id
mapping: pathname
position: top
lang: en # pick a language from https://github.com/giscus/giscus/tree/main/locales
```
#### Utterances
Follow [these steps](https://utteranc.es/)
```yml
params:
comments:
utteranc:
enable: false
repo: username/reponame
issueTerm: pathname
```
##
Loading

0 comments on commit 9576b06

Please sign in to comment.