blob: d8cb82cec50fcab6851b8286787c989158d77149 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
# Hyde
Hyde is a brazen two-column [hugo](https://gohugo.io) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name.
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)
- [Disqus](#disqus)
- [Google Analytics](#google-analytics)
- [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.
### 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.
```html
<!-- 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](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, add the `themeColor` variable under `params`, like so:
**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.
### Reverse layout
To reverse page orientation, add the `layoutReverse` variable under `params`, like so:
**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 your config file.
**TOML**
```toml
disqusShortname = "spf13"
```
**YAML**
```yaml
disqusShortname : spf13
```
> **Note:** Previous version 1.0 the Disqus shortname had to be defined inside the `[params]` block.
## Google Analytics
Google Analytics can be enabled by assigning your tracking code to the `googleAnalytics` variable in the config file:
**TOML**
```toml
googleAnalytics = "Your tracking code"
```
**YAML**
```yaml
googleAnalytics: Your tracking code
```
## Author
**Mark Otto**
- <https://github.com/mdo>
- <https://twitter.com/mdo>
## Ported By
**Steve Francia**
- <https://github.com/spf13>
- <https://twitter.com/spf13>
## License
Open sourced under the [MIT license](LICENSE.md).
<3
|