initial hugo themev1.0

1 files changed, 67 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a864fd4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,67 @@
+Simple minimalistic dark theme for [Hugo](https://gohugo.io/).
+
+![screenshot](https://github.com/gyorb/hugo-dusk/blob/master/images/tn.png "screenshot")
+
+## Features
+
+* Responsive minimalistic design
+* Syntax highlight with [highlight.js](https://highlightjs.org/)
+* [OpenGraph](http://ogp.me/), [Twitter cards](https://dev.twitter.com/cards/overview) support
+* [Disqus](https://disqus.com/) comments support
+* [Google analytics](https://www.google.com/analytics/) (async)
+* Configrable pagination for posts
+* Lazy menu
+* Custom 404 page
+
+## Installation
+
+~~~sh
+$ mkdir themes
+$ cd themes
+$ git clone https://github.com/gyorb/hugo-dusk
+~~~
+
+## Configuration
+
+Example configuration:
+
+~~~~toml
+baseurl = "/"
+title = "My site."
+copyright = "Copyright (c) 2017, all rights reserved."
+canonifyurls = true
+languageCode = "en-US"
+paginate = 3
+theme = "hugo-dusk"
+
+googleAnalytics = ""
+disqusShortname = ""
+
+[author]
+  name = ""
+
+SectionPagesMenu = "main"
+
+[[menu.main]]
+  name = "Posts"
+  weight = -120
+  identifier = "post"
+  url = "/post/"
+
+[[menu.main]]
+  name = "Tags"
+  weight = -110
+  identifier = "tag"
+  url = "/tags/"
+
+[params.meta]
+  keywords = "blog, tech"
+  description = "Personal blog."
+
+[params]
+  github = "github id"
+  gitlab = "gitlab id"
+  twitter = "twitter id"
+  linkedin = "linkedin id"
+  email = "myemail"
+~~~~