Skip to content

Commit

Permalink
docs: uprade disqusShortname/googleAnalytics
Browse files Browse the repository at this point in the history
  • Loading branch information
g1eny0ung committed May 20, 2024
1 parent 66a0d3b commit 8d96ef3
Show file tree
Hide file tree
Showing 7 changed files with 1,913 additions and 1,492 deletions.
2 changes: 1 addition & 1 deletion docs/pages/i18n.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

All of [i18n](https://en.wikipedia.org/wiki/Internationalization_and_localization) files placed in the `i18n` folder.

Now, the dream theme has these languages' translations:
Now, Dream has these languages' translations:

- de
- en
Expand Down
22 changes: 20 additions & 2 deletions docs/pages/index.md → docs/pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Callout } from 'nextra/components'

# Quick Start

**_I assume you have already been browsed [Hugo Docs](https://gohugo.io/documentation/), if you want to use this theme, the docs will help you to understand the configurations._**
Expand All @@ -19,18 +21,34 @@ Dream support [Google Analytics](https://www.google.com/analytics/) for website
In `config.toml`, set:

```toml
googleAnalytics = "..."
[services]
[services.googleAnalytics]
ID = '...'

```

<Callout type="warning" emoji="⚠️">
You may have used `googleAnalytics = "..."` before. This is deprecated in Hugo `0.120.0`.

Please upgrade to the new configuration. See https://gohugo.io/methods/site/googleanalytics/ for more details.
</Callout>

## Social Comments

Dream now use [Disqus](https://disqus.com/) for social comments.

In `config.toml`, set:

```toml
disqusShortname = "..."
[services]
[services.disqus]
shortname = "..."
```
<Callout type="warning" emoji="⚠️">
You may have used `disqusShortname = "..."` before. This is deprecated in Hugo `0.120.0`.

Please upgrade to the new configuration. See https://gohugo.io/methods/site/disqusshortname/ for more details.
</Callout>

## Add "About Me"

Expand Down
29 changes: 0 additions & 29 deletions docs/pages/social-comments.md

This file was deleted.

39 changes: 39 additions & 0 deletions docs/pages/social-comments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { Callout } from 'nextra/components'

# Social Comments

Currently, Dream supports these comment systems:

- [Disqus](https://disqus.com/)
- [utterances](https://utteranc.es/)
- [Valine](https://valine.js.org/en/)

## Disqus

In `config.toml`, set:

```toml
[services]
[services.disqus]
shortname = "..."
```

<Callout type="warning" emoji="⚠️">
You may have used `disqusShortname = "..."` before. This is deprecated in Hugo `0.120.0`.

Please upgrade to the new configuration. See https://gohugo.io/methods/site/disqusshortname/ for more details.
</Callout>

Disqus comments will be showed on the **Single Post Page** and **About Page**.

## utterances

See: https://g1en.site/hugo-theme-dream/#/params-configurations?id=utterancesrepo-quotg1eny0ungg1eny0unggithubioquot

The utterances only takes effect on the **Single Post Page**.

## Valine

See: https://g1en.site/hugo-theme-dream/#/params-configurations?id=valine-true

Valine only takes effect on the **Single Post Page**.
11 changes: 0 additions & 11 deletions docs/pages/website-analytics.md

This file was deleted.

20 changes: 20 additions & 0 deletions docs/pages/website-analytics.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { Callout } from 'nextra/components'

# Website Analytics

Now, Dream only support [Google Analytics](https://www.google.com/analytics/).

In `config.toml`, set:

```toml
[services]
[services.googleAnalytics]
ID = '...'

```

<Callout type="warning" emoji="⚠️">
You may have used `googleAnalytics = "..."` before. This is deprecated in Hugo `0.120.0`.

Please upgrade to the new configuration. See https://gohugo.io/methods/site/googleanalytics/ for more details.
</Callout>
Loading

0 comments on commit 8d96ef3

Please # to comment.