| da66ac19 |
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 |  |
| 7 | |
| 8 | |
| 9 | ## Contents |
| 10 | |
| da66ac19 |
11 | - [Options](#options) |
| 12 | - [Sidebar menu](#sidebar-menu) |
| 13 | - [Sticky sidebar content](#sticky-sidebar-content) |
| 14 | - [Themes](#themes) |
| 15 | - [Reverse layout](#reverse-layout) |
| 16 | - [Development](#development) |
| 17 | - [Author](#author) |
| 5a4a5b18 |
18 | - [Ported by](#ported-by) |
| da66ac19 |
19 | - [License](#license) |
| 20 | |
| 21 | |
| 22 | ## Options |
| 23 | |
| 24 | Hyde includes some customizable options, typically applied via classes on the `<body>` element. |
| 25 | |
| 26 | |
| 27 | ### Sidebar menu |
| 28 | |
| 29 | Create a list of nav links in the sidebar by assigning "menu=main" in the front matter. |
| 30 | |
| 31 | |
| 32 | ### Sticky sidebar content |
| 33 | |
| 34 | 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. |
| 35 | |
| 36 | ```html |
| 37 | <!-- Default sidebar --> |
| 38 | <div class="sidebar"> |
| 39 | <div class="container sidebar-sticky"> |
| 40 | ... |
| 41 | </div> |
| 42 | </div> |
| 43 | |
| 44 | <!-- Modified sidebar --> |
| 45 | <div class="sidebar"> |
| 46 | <div class="container"> |
| 47 | ... |
| 48 | </div> |
| 49 | </div> |
| 50 | ``` |
| 51 | |
| 52 | |
| 53 | ### Themes |
| 54 | |
| 55 | 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). |
| 56 | |
| 57 |  |
| 58 | |
| 59 | There are eight themes available at this time. |
| 60 | |
| 61 |  |
| 62 | |
| 00eb7169 |
63 | To use a theme, add the `themeColor` variable under `params``, like so: |
| da66ac19 |
64 | |
| 00eb7169 |
65 | **TOML** |
| 66 | ```toml |
| 67 | theme = "hyde" |
| 68 | |
| 69 | [params] |
| 70 | themeColor = "theme-base-09" |
| 71 | ``` |
| 72 | |
| 73 | **YAML** |
| 74 | ``` |
| 75 | theme: "hyde" |
| 76 | params: |
| 77 | themeColor: "theme-base-09" |
| da66ac19 |
78 | ``` |
| 79 | |
| 80 | 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. |
| 81 | |
| 82 | ### Reverse layout |
| 83 | |
| 84 |  |
| 85 | |
| 86 | Hyde's page orientation can be reversed with a single class. |
| 87 | |
| 88 | ```html |
| 89 | <body class="layout-reverse"> |
| 90 | ... |
| 91 | </body> |
| 92 | ``` |
| 93 | |
| 94 | ## Author |
| da66ac19 |
95 | **Mark Otto** |
| 96 | - <https://github.com/mdo> |
| 97 | - <https://twitter.com/mdo> |
| 98 | |
| 99 | ## Ported By |
| 100 | **Steve Francia** |
| 101 | - <https://github.com/spf13> |
| 102 | - <https://twitter.com/spf13> |
| 103 | |
| 104 | ## License |
| 105 | |
| 106 | Open sourced under the [MIT license](LICENSE.md). |
| 107 | |
| 108 | <3 |
projects / hyde.git / blame