vbatts/hugo-theme-hyde-hyde
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
cloned from https://github.com/htr3n/hyde-hyde
50 commits 1 branch 4 tags 8.9 MiB
SCSS 41.6%
HTML 38.7%
CSS 19.7%
Find a file
digitalcraftsman d34cfef927 Rename RSSlink to RSSLink
2016-11-17 20:11:20 +01:00
archetypes adding archetypes to the existing themes 2014-05-23 15:45:21 -04:00
images removing old screenshot 2014-10-08 19:17:58 -04:00
layouts Rename RSSlink to RSSLink 2016-11-17 09:18:55 +01:00
static Fixes #22 2015-08-01 13:21:28 +02:00
LICENSE.md Adding the hyde theme 2014-04-26 16:25:13 -06:00
README.md Add installation section 2016-07-26 14:27:07 +02:00
theme.toml Updated theme.toml 2015-07-17 12:38:13 +02:00

README.md

Hyde

Hyde is a brazen two-column hugo theme based on the Jekyll theme of the same name. It pairs a prominent sidebar with uncomplicated content.

Hyde screenshot

Contents

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.

Sidebar menu

Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.

Sticky sidebar content

By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disabled this by removing the .sidebar-sticky class from the sidebar's .container. Sidebar content will then normally flow from top to bottom.

<!-- Default sidebar -->
<div class="sidebar">
  <div class="container sidebar-sticky">
    ...
  </div>
</div>

<!-- Modified sidebar -->
<div class="sidebar">
  <div class="container">
    ...
  </div>
</div>

Themes

Hyde ships with eight optional themes based on the base16 color scheme. Apply a theme to change the color scheme (mostly applies to sidebar and links).

Hyde in red

There are eight themes available at this time.

Hyde theme classes

To use a theme, add the themeColor variable under params, like so:

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. Copy any existing theme (they're only a few lines of CSS), rename it, and change the provided colors.

Reverse layout

Hyde with reverse layout

To reverse page orientation, add the layoutReverse variable under params, like so:

TOML

theme = "hyde"

[params]
  layoutReverse = true

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

[params]
  disqusShortname = "spf13"

YAML

params:
  disqusShortname: "spf13"

Author

Mark Otto

Ported By

Steve Francia

License

Open sourced under the MIT license.

<3