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
6 years ago
6 years ago
6 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  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-02-28T19:41:16+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. demo = ""
  14. [extra.author]
  15. name = "Vincent Prouillet"
  16. homepage = "https://vincent.is"
  17. +++
  18. # hyde
  19. 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.
  20. ![Hyde screenshot](https://f.cloud.github.com/assets/98681/1831228/42af6c6a-7384-11e3-98fb-e0b923ee0468.png)
  21. ## Contents
  22. - [Installation](#installation)
  23. - [Options](#options)
  24. - [Sidebar menu](#sidebar-menu)
  25. - [Sticky sidebar content](#sticky-sidebar-content)
  26. - [Themes](#themes)
  27. - [Reverse layout](#reverse-layout)
  28. ## Installation
  29. First download this theme to your `themes` directory:
  30. ```bash
  31. $ cd themes
  32. $ git clone https://github.com/Keats/hyde.git
  33. ```
  34. and then enable it in your `config.toml`:
  35. ```toml
  36. theme = "hyde"
  37. ```
  38. ## Options
  39. ### Sidebar menu
  40. Set a field in `extra` with a key of `hyde_links`:
  41. ```toml
  42. [extra]
  43. hyde_links = [
  44. {url = "https://google.com", name = "Google.com"},
  45. {url = "https://google.fr", name = "Google.fr"},
  46. ]
  47. ```
  48. Each link needs to have a `url` and a `name`.
  49. ### Sticky sidebar content
  50. 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`.
  51. ### Themes
  52. 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).
  53. ![Hyde in red](https://f.cloud.github.com/assets/98681/1831229/42b0b354-7384-11e3-8462-31b8df193fe5.png)
  54. There are eight themes available at this time.
  55. ![Hyde theme classes](https://f.cloud.github.com/assets/98681/1817044/e5b0ec06-6f68-11e3-83d7-acd1942797a1.png)
  56. To use a theme, set the `hyde_theme` field in `config.toml` to any of the themes name:
  57. ```toml
  58. [extra]
  59. hyde_theme = "theme-base-08"
  60. ```
  61. 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.
  62. ### Reverse layout
  63. ![Hyde with reverse layout](https://f.cloud.github.com/assets/98681/1831230/42b0d3ac-7384-11e3-8d54-2065afd03f9e.png)
  64. Hyde's page orientation can be reversed by setting `hyde_reverse` to `true` in the `config.toml`.