|
1 | | -# Hyde |
2 | | - |
3 | | -Hyde is a brazen two-column [Jekyll](http://jekyllrb.com) theme that pairs a prominent sidebar with uncomplicated content. It's based on [Poole](http://getpoole.com), the Jekyll butler. |
4 | | - |
5 | | - |
6 | | - |
7 | | - |
8 | | -## Contents |
9 | | - |
10 | | -- [Usage](#usage) |
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) |
18 | | -- [License](#license) |
19 | | - |
20 | | - |
21 | | -## Usage |
22 | | - |
23 | | -Hyde is a theme built on top of [Poole](https://github.com/poole/poole), which provides a fully furnished Jekyll setup—just download and start the Jekyll server. See [the Poole usage guidelines](https://github.com/poole/poole#usage) for how to install and use Jekyll. |
24 | | - |
25 | | - |
26 | | -## Options |
27 | | - |
28 | | -Hyde includes some customizable options, typically applied via classes on the `<body>` element. |
29 | | - |
30 | | - |
31 | | -### Sidebar menu |
32 | | - |
33 | | -Create a list of nav links in the sidebar by assigning each Jekyll page the correct layout in the page's [front-matter](http://jekyllrb.com/docs/frontmatter/). |
34 | | - |
35 | | -``` |
36 | | ---- |
37 | | -layout: page |
38 | | -title: About |
39 | | ---- |
40 | | -``` |
41 | | - |
42 | | -**Why require a specific layout?** Jekyll will return *all* pages, including the `atom.xml`, and with an alphabetical sort order. To ensure the first link is *Home*, we exclude the `index.html` page from this list by specifying the `page` layout. |
43 | | - |
44 | | - |
45 | | -### Sticky sidebar content |
46 | | - |
47 | | -By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disable this by removing the `.sidebar-sticky` class from the sidebar's `.container`. Sidebar content will then normally flow from top to bottom. |
48 | | - |
49 | | -```html |
50 | | -<!-- Default sidebar --> |
51 | | -<div class="sidebar"> |
52 | | - <div class="container sidebar-sticky"> |
53 | | - ... |
54 | | - </div> |
55 | | -</div> |
56 | | - |
57 | | -<!-- Modified sidebar --> |
58 | | -<div class="sidebar"> |
59 | | - <div class="container"> |
60 | | - ... |
61 | | - </div> |
62 | | -</div> |
63 | | -``` |
64 | | - |
65 | | - |
66 | | -### Themes |
67 | | - |
68 | | -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). |
69 | | - |
70 | | - |
71 | | - |
72 | | -There are eight themes available at this time. |
73 | | - |
74 | | - |
75 | | - |
76 | | -To use a theme, add anyone of the available theme classes to the `<body>` element in the `default.html` layout, like so: |
77 | | - |
78 | | -```html |
79 | | -<body class="theme-base-08"> |
80 | | - ... |
81 | | -</body> |
82 | | -``` |
83 | | - |
84 | | -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. |
85 | | - |
86 | | -### Reverse layout |
87 | | - |
88 | | - |
89 | | - |
90 | | -Hyde's page orientation can be reversed with a single class. |
91 | | - |
92 | | -```html |
93 | | -<body class="layout-reverse"> |
94 | | - ... |
95 | | -</body> |
96 | | -``` |
97 | | - |
98 | | - |
99 | | -## Development |
100 | | - |
101 | | -Hyde has two branches, but only one is used for active development. |
102 | | - |
103 | | -- `master` for development. **All pull requests should be submitted against `master`.** |
104 | | -- `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.** |
105 | | - |
106 | | - |
107 | | -## Author |
108 | | - |
109 | | -**Mark Otto** |
110 | | -- <https://github.com/mdo> |
111 | | -- <https://twitter.com/mdo> |
112 | | - |
113 | | - |
114 | | -## License |
115 | | - |
116 | | -Open sourced under the [MIT license](LICENSE.md). |
117 | | - |
118 | | -<3 |
| 1 | +This is the source for [messageformat.github.io](https://messageformat.github.io/), the site for [messageformat.js](https://github.com/SlexAxton/messageformat.js). |
0 commit comments