]>
Commit | Line | Data |
---|---|---|
1 | # Hyde | |
2 | ||
3 | Hyde is a brazen two-column [hugo](http://hugo.spf13.com) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name. | |
4 | It pairs a prominent sidebar with uncomplicated content. | |
5 | ||
6 | ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png) | |
7 | ||
8 | ||
9 | ## Contents | |
10 | ||
11 | - [Installation](#installation) | |
12 | - [Options](#options) | |
13 | - [Sidebar menu](#sidebar-menu) | |
14 | - [Sticky sidebar content](#sticky-sidebar-content) | |
15 | - [Themes](#themes) | |
16 | - [Reverse layout](#reverse-layout) | |
17 | - [Disqus](#disqus) | |
18 | - [Author](#author) | |
19 | - [Ported by](#ported-by) | |
20 | - [License](#license) | |
21 | ||
22 | ||
23 | ## Installation | |
24 | ||
25 | To install Hyde as your default theme, first install this repository in the `themes/` directory: | |
26 | ||
27 | $ cd themes/ | |
28 | $ git clone https://github.com/spf13/hyde.git | |
29 | ||
30 | Second, specify `hyde` as your default theme in the `config.toml` file. Just add the line | |
31 | ||
32 | theme = "hyde" | |
33 | ||
34 | at the top of the file. | |
35 | ||
36 | ||
37 | ## Options | |
38 | ||
39 | Hyde includes some customizable options, typically applied via classes on the `<body>` element. | |
40 | ||
41 | ||
42 | ### Sidebar menu | |
43 | ||
44 | Create a list of nav links in the sidebar by assigning "menu=main" in the front matter. | |
45 | ||
46 | ||
47 | ### Sticky sidebar content | |
48 | ||
49 | 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. | |
50 | ||
51 | ```html | |
52 | <!-- Default sidebar --> | |
53 | <div class="sidebar"> | |
54 | <div class="container sidebar-sticky"> | |
55 | ... | |
56 | </div> | |
57 | </div> | |
58 | ||
59 | <!-- Modified sidebar --> | |
60 | <div class="sidebar"> | |
61 | <div class="container"> | |
62 | ... | |
63 | </div> | |
64 | </div> | |
65 | ``` | |
66 | ||
67 | ||
68 | ### Themes | |
69 | ||
70 | 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). | |
71 | ||
72 | ![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png) | |
73 | ||
74 | There are eight themes available at this time. | |
75 | ||
76 | ![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png) | |
77 | ||
78 | To use a theme, add the `themeColor` variable under `params`, like so: | |
79 | ||
80 | **TOML** | |
81 | ```toml | |
82 | theme = "hyde" | |
83 | ||
84 | [params] | |
85 | themeColor = "theme-base-09" | |
86 | ``` | |
87 | ||
88 | **YAML** | |
89 | ```yaml | |
90 | theme: "hyde" | |
91 | ||
92 | params: | |
93 | themeColor: "theme-base-09" | |
94 | ``` | |
95 | ||
96 | 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. | |
97 | ||
98 | ### Reverse layout | |
99 | ||
100 | ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png) | |
101 | ||
102 | To reverse page orientation, add the `layoutReverse` variable under `params`, like so: | |
103 | ||
104 | **TOML** | |
105 | ```toml | |
106 | theme = "hyde" | |
107 | ||
108 | [params] | |
109 | layoutReverse = true | |
110 | ``` | |
111 | ||
112 | **YAML** | |
113 | ```yaml | |
114 | theme: "hyde" | |
115 | ||
116 | params: | |
117 | layoutReverse: true | |
118 | ``` | |
119 | ||
120 | ### Disqus | |
121 | ||
122 | 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. | |
123 | ||
124 | **TOML** | |
125 | ```toml | |
126 | [params] | |
127 | disqusShortname = "spf13" | |
128 | ``` | |
129 | ||
130 | **YAML** | |
131 | ```yaml | |
132 | params: | |
133 | disqusShortname: "spf13" | |
134 | ``` | |
135 | ||
136 | ## Author | |
137 | **Mark Otto** | |
138 | - <https://github.com/mdo> | |
139 | - <https://twitter.com/mdo> | |
140 | ||
141 | ## Ported By | |
142 | **Steve Francia** | |
143 | - <https://github.com/spf13> | |
144 | - <https://twitter.com/spf13> | |
145 | ||
146 | ## License | |
147 | ||
148 | Open sourced under the [MIT license](LICENSE.md). | |
149 | ||
150 | <3 |