summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorroninro <liumy.f@foxmail.com>2022-07-28 19:38:00 +0800
committerroninro <liumy.f@foxmail.com>2022-07-28 19:38:00 +0800
commit25bf7c8342ba8ecb59363bf6043dc62a3585bf87 (patch)
tree81178d8a453226a0d01753c35899a2136a204a67
parentb60e2467de21a7760ca60e472901d5de4c11d8ba (diff)
update README.md
-rw-r--r--README.md94
-rw-r--r--theme.toml2
2 files changed, 5 insertions, 91 deletions
diff --git a/README.md b/README.md
index 18aea5c..fb4e58b 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,8 @@
> Ported Theme of [Hux Blog](https://github.com/Huxpro/huxpro.github.io), Thank [Huxpro](https://github.com/Huxpro) for designing such a flawless theme.
+[Demo](https://hugo-theme-puppet.netlify.app/)
+
## Installation
```bash
@@ -10,97 +12,9 @@ $ git clone https://github.com/roninro/hugo-theme-puppet.git themes/puppet
## Configuration
-Config.toml example
-
-```toml
-baseurl = "/"
-title = "Puppet"
-languageCode = "en-us"
-paginate = 10 # Number of posts per page
-theme = "puppet"
-
-disqusShortname = "" # Enable Disqus comments by entering your Disqus shortname
-
-enableInlineShortcodes = true
-enableEmoji = true
-
-
-[outputs]
-home = ["HTML", "JSON"]
-
-[taxonomies]
-category = "categories"
-tag = "tags"
-series = "series" #
-
-[markup]
-[markup.highlight]
-codeFences = true
-guessSyntax = true
-lineNos = true
-lineNumbersInTable = false
-style = "dracula"
-
-[markup.goldmark.renderer]
-unsafe = true
+Take a look inside the [exampleSite](exampleSite) folder of this theme. You'll find a file called [config.toml](exampleSite/config.toml).
+To use it, copy the [config.toml](exampleSite/config.toml) in the root directory of your website. Overwrite the existing config file if necessary.
-[menu]
-[[menu.main]]
-identifier = "home"
-name = "Home"
-url = "/"
-weight = -100
-[[menu.main]]
-identifier = "about"
-name = "About"
-url = "/about/"
-weight = 100
-[[menu.main]]
-identifier = "archive"
-name = "Archive"
-url = "/archive/"
-weight = 10
-
-
-[params]
-author = "Puppet"
-description = "A simple and clean theme for Hugo"
-keywords = "blog,developer,personal"
-img_home = "/img/home-bg.jpg"
-img_404 = "/img/404-bg.jpg"
-
-[params.sidebar]
-enable = true
-avatar = "/img/home-bg.jpg"
-bio = "John Doe's personal website"
-
-[params.social]
-rss_enable = true
-twitter = "johndoe"
-facebook = "johndoe"
-zhihu = "johndoe"
-weibo = "johndoe"
-github = "johndoe"
-linkedin = "johndoe"
-
-[[params.friends]]
-name = "John Doe"
-url = "https://gohugo.io"
-
-[[params.friends]]
-name = "John Doe"
-url = "https://gohugo.io"
-
-# See https://giscus.app/
-[params.giscus]
-enable = false
-repo = ""
-repo_id = ""
-category = ""
-category_id = ""
-input_position = ""
-theme = "light"
-```
## Front Matter example
diff --git a/theme.toml b/theme.toml
index 97565bc..d208216 100644
--- a/theme.toml
+++ b/theme.toml
@@ -7,7 +7,7 @@ licenselink = "https://github.com/roninro/hugo-theme-puppet/blob/master/LICENSE"
description = ""
homepage = "https://github.com/roninro/hugo-theme-puppet"
# If you have a running demo of the theme.
-demosite = ""
+demosite = "https://hugo-theme-puppet.netlify.app/"
tags = ["blog", "simple", "clean"]
features = ["responsive", "blog", "simple", "search"]