You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.md 2.7KB

6 years ago
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. +++
  2. title = "hyde"
  3. description = "A classic blog theme"
  4. template = "theme.html"
  5. date = 2017-10-24T15:01:52+02:00
  6. [extra]
  7. created = 2018-01-25T18:45:36+01:00
  8. updated = 2017-10-24T15:01:52+02:00
  9. repository = "https://github.com/Keats/hyde"
  10. homepage = "https://github.com/Keats/gutenberg-hyde"
  11. minimum_version = "0.2"
  12. license = "MIT"
  13. [extra.author]
  14. name = "Vincent Prouillet"
  15. homepage = "https://vincent.is"
  16. +++
  17. # hyde
  18. Hyde is a brazen two-column [Gutenberg](https://github.com/Keats/gutenberg) based on the Jekyll theme of the same name that pairs a prominent sidebar with uncomplicated content.
  19. ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)
  20. ## Contents
  21. - [Installation](#installation)
  22. - [Options](#options)
  23. - [Sidebar menu](#sidebar-menu)
  24. - [Sticky sidebar content](#sticky-sidebar-content)
  25. - [Themes](#themes)
  26. - [Reverse layout](#reverse-layout)
  27. ## Installation
  28. First download this theme to your `themes` directory:
  29. ```bash
  30. $ cd themes
  31. $ git clone https://github.com/Keats/hyde.git
  32. ```
  33. and then enable it in your `config.toml`:
  34. ```toml
  35. theme = "hyde"
  36. ```
  37. ## Options
  38. ### Sidebar menu
  39. Set a field in `extra` with a key of `hyde_links`:
  40. ```toml
  41. [extra]
  42. hyde_links = [
  43. {url = "https://google.com", name = "Google.com"},
  44. {url = "https://google.fr", name = "Google.fr"},
  45. ]
  46. ```
  47. Each link needs to have a `url` and a `name`.
  48. ### Sticky sidebar content
  49. By default Hyde ships with a sidebar that affixes it's content to the bottom of the sidebar. You can optionally disable this by setting `hyde_sticky` to false in your `config.toml`.
  50. ### Themes
  51. 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).
  52. ![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png)
  53. There are eight themes available at this time.
  54. ![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png)
  55. To use a theme, set the `hyde_theme` field in `config.toml` to any of the themes name:
  56. ```toml
  57. [extra]
  58. hyde_theme = "theme-base-08"
  59. ```
  60. 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.
  61. ### Reverse layout
  62. ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)
  63. Hyde's page orientation can be reversed by setting `hyde_reversed` to `true` in the `config.toml`.