Merge branch 'master' of github.com:alanpearce/hyde

author: Alan Pearce 2017-07-04 20:40:28 +0200
committer: Alan Pearce 2017-07-04 20:40:28 +0200
commit: 3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73 (patch)
tree: 603637579a90af0fb92762cc112881488909c890
parent: 022af90cb3aa08e891639f3db47ad3bb7b47632a (diff)
parent: 24492a6c1b5a081847bc6f6de2d6aa7a7d32b04f (diff)
download: hyde-3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73.tar.lz
hyde-3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73.tar.zst
hyde-3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73.zip
12 files changed, 107 insertions, 24 deletions
diff --git a/README.md b/README.md
index 2502796..45ee21f 100644
--- a/README.md
+++ b/README.md
@@ -8,17 +8,32 @@ It pairs a prominent sidebar with uncomplicated content.
 
 ## Contents
 
+- [Installation](#installation)
 - [Options](#options)
   - [Sidebar menu](#sidebar-menu)
   - [Sticky sidebar content](#sticky-sidebar-content)
   - [Themes](#themes)
   - [Reverse layout](#reverse-layout)
-- [Development](#development)
+  - [Disqus](#disqus)
 - [Author](#author)
 - [Ported by](#ported-by)
 - [License](#license)
 
 
+## Installation
+
+To install Hyde as your default theme, first install this repository in the `themes/` directory:
+
+    $ cd themes/
+    $ git clone https://github.com/spf13/hyde.git
+
+Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line
+
+    theme = "hyde"
+
+at the top of the file.
+
+
 ## Options
 
 Hyde includes some customizable options, typically applied via classes on the `<body>` element.
@@ -60,12 +75,22 @@ There are eight themes available at this time.
 
 ![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png)
 
-To use a theme, add anyone of the available theme classes to the `<body>` element in the `default.html` layout, like so:
+To use a theme, add the `themeColor` variable under `params`, like so:
 
-```html
-<body class="theme-base-08">
-  ...
-</body>
+**TOML**
+```toml
+theme = "hyde"
+
+[params]
+  themeColor = "theme-base-09"
+```
+
+**YAML**
+```yaml
+theme: "hyde"
+
+params:
+  themeColor: "theme-base-09"
 ```
 
 To create your own theme, look to the Themes section of [included CSS file](https://github.com/poole/hyde/blob/master/public/css/hyde.css). Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.
@@ -74,12 +99,38 @@ To create your own theme, look to the Themes section of [included CSS file](http
 
 ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)
 
-Hyde's page orientation can be reversed with a single class.
+To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
 
-```html
-<body class="layout-reverse">
-  ...
-</body>
+**TOML**
+```toml
+theme = "hyde"
+
+[params]
+  layoutReverse = true
+```
+
+**YAML**
+```yaml
+theme: "hyde"
+
+params:
+  layoutReverse: true
+```
+
+### Disqus
+
+You can optionally enable a comment system powered by Disqus for the posts. Simply add the variable `disqusShortname` to the `params` in your config file.
+
+**TOML**
+```toml
+[params]
+  disqusShortname = "spf13"
+```
+
+**YAML**
+```yaml
+params:
+  disqusShortname: "spf13"
 ```
 
 ## Author
diff --git a/images/screenshot.png b/images/screenshot.png
new file mode 100644
index 0000000..8248097
--- /dev/null
+++ b/images/screenshot.png
Binary files differdiff --git a/images/screenshot1.png b/images/screenshot1.png
deleted file mode 100644
index 56cc154..0000000
--- a/images/screenshot1.png
+++ /dev/null
Binary files differdiff --git a/layouts/404.html b/layouts/404.html
new file mode 100644
index 0000000..8fa1a59
--- /dev/null
+++ b/layouts/404.html
@@ -0,0 +1,12 @@
+{{ partial "head.html" . }}
+<body class="{{ .Site.Params.themeColor }}">
+
+{{ partial "sidebar.html" . }}
+
+    <div class="content container">
+      <h1>404: Page not found</h1>
+        <p class="lead">Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. <a href="{{ .Site.BaseURL }}">Head back home</a> to try finding it again.</p>
+    </div>
+
+  </body>
+</html>
diff --git a/layouts/_default/list.html b/layouts/_default/list.html
index f6fad64..f412982 100644
--- a/layouts/_default/list.html
+++ b/layouts/_default/list.html
@@ -1,5 +1,5 @@
 {{ partial "head.html" . }}
-	<body class="theme-base-0b layout-reverse">
+  <body class="{{ .Site.Params.themeColor }} {{if .Site.Params.layoutReverse}}layout-reverse{{end}}">
 		<main class="content container" role="main">
 			<h1 class="page-title">{{ .Title }}</h1>
 			<ul class="posts">
diff --git a/layouts/_default/single.html b/layouts/_default/single.html
index 390ecf0..1f48df8 100644
--- a/layouts/_default/single.html
+++ b/layouts/_default/single.html
@@ -1,5 +1,5 @@
 {{ partial "head.html" . }}
-	<body class="theme-base-0b layout-reverse h-entry">
+  <body class="{{ .Site.Params.themeColor }} {{if .Site.Params.layoutReverse}}layout-reverse{{end}} h-entry">
 		<main class="content container" role="main">
 			<article class="post">
 				<header>
diff --git a/layouts/index.html b/layouts/index.html
index cdca9ae..9d181dc 100644
--- a/layouts/index.html
+++ b/layouts/index.html
@@ -1,5 +1,5 @@
 {{ partial "head.html" . }}
-	<body class="theme-base-0b layout-reverse">
+	<body class="{{ .Site.Params.themeColor }} {{if .Site.Params.layoutReverse}}layout-reverse{{end}}">
 		<main class="content container" role="main">
 			<section class="recent">
 				<h2>Recent Posts</h2>
diff --git a/layouts/partials/disqus.html b/layouts/partials/disqus.html
new file mode 100644
index 0000000..323ae04
--- /dev/null
+++ b/layouts/partials/disqus.html
@@ -0,0 +1,14 @@
+<div id="disqus_thread"></div>
+<script type="text/javascript">
+    /* * * CONFIGURATION VARIABLES: EDIT BEFORE PASTING INTO YOUR WEBPAGE * * */
+    var disqus_shortname = '{{ .Site.Params.disqusShortname }}'; // Required - Replace '<example>' with your forum shortname
+
+    /* * * DON'T EDIT BELOW THIS LINE * * */
+    (function() {
+        var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
+        dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
+        (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
+    })();
+</script>
+<noscript>Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
+</div>
\ No newline at end of file
diff --git a/layouts/partials/head.html b/layouts/partials/head.html
index e8e7596..59304c2 100644
--- a/layouts/partials/head.html
+++ b/layouts/partials/head.html
@@ -3,7 +3,13 @@
 	<head>
 		<meta charset="UTF-8">
 		<meta name="viewport" content="width=device-width,initial-scale=1">
-		<title>{{ if ne .Title .Site.Title }}{{ .Title }} · {{ end }}{{ .Site.Title }}</title>
+
+		{{ if .IsHome }}
+		<title>{{ .Site.Title }}</title>
+		{{ else }}
+		<title>{{ .Title }} &middot; {{ .Site.Title }}</title>
+		{{ end }}
+
 		<link rel="stylesheet" href="/css/poole.css">
 		<link rel="stylesheet" href="/css/syntax.css">
 		<link rel="stylesheet" href="/css/hyde.css">
diff --git a/layouts/partials/sidebar.html b/layouts/partials/sidebar.html
index 51e68c6..53d41cf 100644
--- a/layouts/partials/sidebar.html
+++ b/layouts/partials/sidebar.html
@@ -1,7 +1,7 @@
 		<aside class="sidebar container">
 			<header class="sidebar-about h-card vcard p-author">
 				{{ if (isset .Site.Author "image") }}
-				<a class="u-url u-uid" href="{{ .Site.BaseURL }}">
+				<a class="u-url u-uid" rel="me" href="{{ .Site.BaseURL }}">
 					<img class="u-photo" src="{{ .Site.Author.image }}" width=128 height=128 />
 				</a>
 				{{ end }}
@@ -19,7 +19,7 @@
 				<nav>
 					<ul class="sidebar-nav">
 						{{ range .Site.Menus.main }}
-						<li><a href="{{.URL}}" class="u-url url"> {{ .Name }} </a></li>
+						<li><a href="{{.URL}}"> {{ .Name }} </a></li>
 						{{end}}
 					</ul>
 				</nav>
@@ -32,7 +32,7 @@
 							{{ if hasPrefix .URL "mailto:" }}
 							<a href="{{ .URL }}" class="u-email email" rel="me">{{ .Name }}</a>
 							{{ else }}
-							<a href="{{ .URL }}" rel="me">{{ .Name }}</a>
+							<a href="{{ .URL }}" class="u-url url" rel="me">{{ .Name }}</a>
 						{{ end }}
 						</li>
 						{{ end }}
diff --git a/static/touch-icon-144-precomposed.png b/static/apple-touch-icon-144-precomposed.png
index 19323de..19323de 100644
--- a/static/touch-icon-144-precomposed.png
+++ b/static/apple-touch-icon-144-precomposed.png
Binary files differdiff --git a/theme.toml b/theme.toml
index 2fc1110..66ca805 100644
--- a/theme.toml
+++ b/theme.toml
@@ -1,17 +1,17 @@
 name = "Hyde"
 license = "MIT"
-source_repo = ""
+licenselink = "https://github.com/spf13/hyde/blob/master/LICENSE.md"
 description = "An elegant open source and mobile first theme"
 tags = ["blog", "company"]
-features = ["blog", ]
+features = ["blog", "themes", "disqus"]
+min_version = 0.20
 
 [author]
     name = "spf13"
-    email = "hugo@spf13.com"
-    url = "http://spf13.com"
+    homepage = "http://spf13.com"
 
 # If Porting existing theme
 [original]
     author =  "mdo"
-    url = "http://andhyde.com"
-    repo = "http://www.github.com/mdo/hyde"
+    homepage = "http://markdotto.com/"
+    repo = "https://www.github.com/mdo/hyde"
author	Alan Pearce	2017-07-04 20:40:28 +0200
committer	Alan Pearce	2017-07-04 20:40:28 +0200
commit	3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73 (patch)
tree	603637579a90af0fb92762cc112881488909c890
parent	022af90cb3aa08e891639f3db47ad3bb7b47632a (diff)
parent	24492a6c1b5a081847bc6f6de2d6aa7a7d32b04f (diff)
download	hyde-3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73.tar.lz hyde-3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73.tar.zst hyde-3fb00f95d8f99fe57f3c49b3eb299c0b62af7e73.zip