diff options
| author | spf13 <steve.francia@gmail.com> | 2014-04-26 16:25:13 -0600 |
|---|---|---|
| committer | spf13 <steve.francia@gmail.com> | 2014-04-26 16:25:13 -0600 |
| commit | da66ac1983b586765652f54bf556f268f1e32ff4 (patch) | |
| tree | c5cf3722e926455c30c8113c473e0e73aef04312 /README.md | |
Adding the hyde theme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..029095a --- /dev/null +++ b/README.md @@ -0,0 +1,100 @@ +# Hyde + +Hyde is a brazen two-column [hugo](http://hugo.spf13.com) theme based on the [Jekyll](http://jekyllrb.com) theme of the same name. +It pairs a prominent sidebar with uncomplicated content. + + + + +## Contents + +- [Usage](#usage) +- [Options](#options) + - [Sidebar menu](#sidebar-menu) + - [Sticky sidebar content](#sticky-sidebar-content) + - [Themes](#themes) + - [Reverse layout](#reverse-layout) +- [Development](#development) +- [Author](#author) +- [License](#license) + + +## 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 anyone of the available theme classes to the `<body>` element in the `default.html` layout, like so: + +```html +<body class="theme-base-08"> + ... +</body> +``` + +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 with a single class. + +```html +<body class="layout-reverse"> + ... +</body> +``` + +## 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 |