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 1.9KB

6 years ago
6 years ago
6 years ago
6 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. +++
  2. title = "even"
  3. description = "A robust, elegant dark theme"
  4. template = "theme.html"
  5. date = 2018-01-25T18:44:44+01:00
  6. [extra]
  7. created = 2018-02-22T19:13:36+01:00
  8. updated = 2018-01-25T18:44:44+01:00
  9. repository = "https://github.com/Keats/even"
  10. homepage = "https://github.com/Keats/even"
  11. minimum_version = "0.4.0"
  12. license = "MIT"
  13. demo = "https://gutenberg-even.netlify.com"
  14. [extra.author]
  15. name = "Vincent Prouillet"
  16. homepage = "https://vincent.is"
  17. +++
  18. # Even
  19. Even is a clean, responsive theme based on the Hugo theme with the same name featuring categories, tags and pagination.
  20. ![even screenshot](https://github.com/Keats/even/blob/master/screenshot.png?raw=true)
  21. ## Contents
  22. - [Installation](#installation)
  23. - [Options](#options)
  24. - [Top menu](#top-menu)
  25. - [Title](#title)
  26. ## Installation
  27. First download this theme to your `themes` directory:
  28. ```bash
  29. $ cd themes
  30. $ git clone https://github.com/Keats/even.git
  31. ```
  32. and then enable it in your `config.toml`:
  33. ```toml
  34. theme = "even"
  35. ```
  36. The theme requires tags and categories taxonomies to be enabled in your `config.toml`:
  37. ```toml
  38. taxonomies = [
  39. # You can enable/disable RSS
  40. {name = "categories", rss = true},
  41. {name = "tags", rss = true},
  42. ]
  43. ```
  44. If you want to paginate taxonomies pages, you will need to overwrite the templates
  45. as it only works for non-paginated taxonomies by default.
  46. ## Options
  47. ### Top-menu
  48. Set a field in `extra` with a key of `even_menu`:
  49. ```toml
  50. # This is the default menu
  51. even_menu = [
  52. {url = "$BASE_URL", name = "Home"},
  53. {url = "$BASE_URL/categories", name = "Categories"},
  54. {url = "$BASE_URL/tags", name = "Tags"},
  55. {url = "$BASE_URL/about", name = "About"},
  56. ]
  57. ```
  58. If you put `$BASE_URL` in a url, it will automatically be replaced by the actual
  59. site URL.
  60. ### Title
  61. The site title is shown on the header. As it might be different from the `<title>`
  62. element that the `title` field in the config represents, you can set the `even_title`
  63. instead.