89 lines
2.7 KiB
Markdown
89 lines
2.7 KiB
Markdown
|
|
+++
|
|
title = "hyde"
|
|
description = "A classic blog theme"
|
|
template = "theme.html"
|
|
date = 2017-10-24T15:01:52+02:00
|
|
|
|
[extra]
|
|
created = 2018-01-25T18:45:36+01:00
|
|
updated = 2017-10-24T15:01:52+02:00
|
|
repository = "https://github.com/Keats/hyde"
|
|
homepage = "https://github.com/Keats/gutenberg-hyde"
|
|
minimum_version = "0.2"
|
|
license = "MIT"
|
|
|
|
[extra.author]
|
|
name = "Vincent Prouillet"
|
|
homepage = "https://vincent.is"
|
|
+++
|
|
|
|
# hyde
|
|
Hyde is a brazen two-column [Gutenberg](https://github.com/Keats/gutenberg) based on the Jekyll theme of the same name that 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)
|
|
|
|
## Installation
|
|
First download this theme to your `themes` directory:
|
|
|
|
```bash
|
|
$ cd themes
|
|
$ git clone https://github.com/Keats/hyde.git
|
|
```
|
|
and then enable it in your `config.toml`:
|
|
|
|
```toml
|
|
theme = "hyde"
|
|
```
|
|
|
|
## Options
|
|
|
|
### Sidebar menu
|
|
Set a field in `extra` with a key of `hyde_links`:
|
|
```toml
|
|
[extra]
|
|
hyde_links = [
|
|
{url = "https://google.com", name = "Google.com"},
|
|
{url = "https://google.fr", name = "Google.fr"},
|
|
]
|
|
```
|
|
Each link needs to have a `url` and a `name`.
|
|
|
|
### Sticky sidebar content
|
|
By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disable this by setting `hyde_sticky` to false in your `config.toml`.
|
|
|
|
### Themes
|
|
Hyde ships with eight optional themes based on the [base16 color scheme](https://github.com/chriskempson/base16). Apply a theme to change the color scheme (mostly applies to sidebar and links).
|
|
|
|
|
|
|
|
There are eight themes available at this time.
|
|
|
|
|
|
|
|
To use a theme, set the `hyde_theme` field in `config.toml` to any of the themes name:
|
|
|
|
```toml
|
|
[extra]
|
|
hyde_theme = "theme-base-08"
|
|
```
|
|
|
|
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.
|
|
|
|
### Reverse layout
|
|
|
|
|
|
|
|
Hyde's page orientation can be reversed by setting `hyde_reversed` to `true` in the `config.toml`.
|
|
|
|
|