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.1KB

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