From 00eb7169f6062b041e4aa8402b96fce39ce0aa16 Mon Sep 17 00:00:00 2001 From: digitalcraftsman Date: Tue, 2 Jun 2015 19:14:54 +0200 Subject: Added an option change the theme globally in the configs --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 2502796..3233a15 100644 --- a/README.md +++ b/README.md @@ -60,12 +60,21 @@ 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 `` element in the `default.html` layout, like so: +To use a theme, add the `themeColor` variable under `params``, like so: -```html - - ... - +**TOML** +```toml +theme = "hyde" + +[params] + themeColor = "theme-base-09" +``` + +**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. -- cgit 1.4.1 From a874cebd9844764360be9ab93568cc6e334b0e4e Mon Sep 17 00:00:00 2001 From: digitalcraftsman Date: Wed, 15 Jul 2015 12:19:53 +0200 Subject: Updated README --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 3233a15..0ddc6d5 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ 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 the `themeColor` variable under `params``, like so: +To use a theme, add the `themeColor` variable under `params`, like so: **TOML** ```toml @@ -71,8 +71,9 @@ theme = "hyde" ``` **YAML** -``` +```yaml theme: "hyde" + params: themeColor: "theme-base-09" ``` -- cgit 1.4.1 From 62ef2ef06f36bccddecaffc9567898899c29036d Mon Sep 17 00:00:00 2001 From: digitalcraftsman Date: Fri, 17 Jul 2015 12:21:50 +0200 Subject: Added Disqus support --- README.md | 17 +++++++++++++++++ layouts/_default/single.html | 24 ++++++++++++++---------- layouts/partials/disqus.html | 14 ++++++++++++++ 3 files changed, 45 insertions(+), 10 deletions(-) create mode 100644 layouts/partials/disqus.html (limited to 'README.md') diff --git a/README.md b/README.md index 0ddc6d5..70a57ec 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ It pairs a prominent sidebar with uncomplicated content. - [Sticky sidebar content](#sticky-sidebar-content) - [Themes](#themes) - [Reverse layout](#reverse-layout) + - [Disqus](#disqus) - [Development](#development) - [Author](#author) - [Ported by](#ported-by) @@ -92,6 +93,22 @@ Hyde's page orientation can be reversed with a single class. ``` +### 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 **Mark Otto** - diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 9f4f603..6bd2524 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -1,15 +1,19 @@ -{{ partial "head.html" . }} - + {{ partial "head.html" . }} + + {{ partial "sidebar.html" . }} -{{ partial "sidebar.html" . }} +
+
+

{{ .Title }}

+ + {{ .Content }} +
-
-
-

{{ .Title }}

- - {{ .Content }} -
-
+ {{ if and (isset .Site.Params "disqusShortname") (ne .Site.Params.disqusShortname "") }} +

Comments

+ {{ partial "disqus" . }} + {{ end }} +
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 @@ +
+ + + \ No newline at end of file -- cgit 1.4.1 From 6fdb7f9d4b5932fb7fbf6fcf4c61bf9e7b7bf584 Mon Sep 17 00:00:00 2001 From: digitalcraftsman Date: Fri, 17 Jul 2015 12:28:12 +0200 Subject: Removed non-working link from README --- README.md | 1 - 1 file changed, 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 70a57ec..39b8d14 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ It pairs a prominent sidebar with uncomplicated content. - [Themes](#themes) - [Reverse layout](#reverse-layout) - [Disqus](#disqus) -- [Development](#development) - [Author](#author) - [Ported by](#ported-by) - [License](#license) -- cgit 1.4.1 From a04b9e15746f679a3a6d8f325b82e2392b20d380 Mon Sep 17 00:00:00 2001 From: Ján Koščo Date: Tue, 8 Mar 2016 23:15:24 +0100 Subject: Add configuration to Reverse layout --- README.md | 20 +++++++++++++++----- layouts/index.html | 2 +- 2 files changed, 16 insertions(+), 6 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 39b8d14..0235f16 100644 --- a/README.md +++ b/README.md @@ -84,12 +84,22 @@ 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 - - ... - +**TOML** +```toml +theme = "hyde" + +[params] + layoutReverse = true +``` + +**YAML** +```yaml +theme: "hyde" + +params: + layoutReverse: true ``` ### Disqus diff --git a/layouts/index.html b/layouts/index.html index 6ba175e..36f3ac2 100644 --- a/layouts/index.html +++ b/layouts/index.html @@ -1,5 +1,5 @@ {{ partial "head.html" . }} - + {{ partial "sidebar.html" . }} -- cgit 1.4.1 From fff9d5b21f50bbe11e9b9329867d6f70669de81f Mon Sep 17 00:00:00 2001 From: Pedro Melo Date: Tue, 26 Jul 2016 13:27:07 +0100 Subject: Add installation section --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) (limited to 'README.md') diff --git a/README.md b/README.md index 0235f16..45ee21f 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ It pairs a prominent sidebar with uncomplicated content. ## Contents +- [Installation](#installation) - [Options](#options) - [Sidebar menu](#sidebar-menu) - [Sticky sidebar content](#sticky-sidebar-content) @@ -19,6 +20,20 @@ It pairs a prominent sidebar with uncomplicated content. - [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 `` element. -- cgit 1.4.1