Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/wd/hugo-fabric.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwd <wd@wdicc.com>2017-03-10 14:21:41 +0300
committerwd <wd@wdicc.com>2017-03-10 14:21:41 +0300
commit59a583f51b1e19b2a805ee7eb9ba1bf976e0eb93 (patch)
treee884a8ffda01e151d9a0fc5a173b0af83bbbbfb1 /README.md
parent50754afdf05da0c3d14e5806fc6d97ae043dbdd7 (diff)
edit readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 49 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8e1ffc7..60f81e2 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,50 @@
# hugo-fabric
-Hugo Fabric Theme
+Hugo Fabric Theme, forked from https://github.com/wd/hexo-fabric. You can visit the live demo at https://wdicc.com.
+
+# Installation
+
+First clone this repository in the `themes/` directory:
+
+```
+$ cd themes/
+$ git clone https://github.com/wd/hugo-fabric
+```
+
+Second, specify `hugo-fabric` as your default theme in the config.toml file. Just add the line
+
+```
+theme = "hugo-fabric"
+```
+
+# Theme settings
+
+Put settings below into your config.toml.
+
+```
+[params]
+ author = "wd"
+ [params.theme]
+ subtitle = "happy every day"
+ post_type = "page" # For archive
+ archive_post_type = "archives"
+
+ # social account
+ github_user = "wd"
+ twitter_user = "wd"
+ disqus_shortname = "wdicc"
+
+ # post sharing
+ facebook_like = true
+ twitter_tweet_button = true
+ google_plus_one = true
+ google_plus_one_size = "midum"
+ addthis_profile_id = "wd"
+```
+
+# Archive support
+
+Create a new file `hugo new archives.md`, and edit this file, add the following line in front matter.
+
+```
+type = "archives"
+```