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

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  1. +++
  2. title = "feather"
  3. description = "A modern blog theme"
  4. template = "theme.html"
  5. date = 2018-01-21T04:35:36-05:00
  6. [extra]
  7. created = 2019-07-12T23:49:55+02:00
  8. updated = 2018-01-21T04:35:36-05:00
  9. repository = "https://github.com/piedoom/feather"
  10. homepage = "https://github.com/piedoom/feather"
  11. minimum_version = "0.5.1"
  12. license = "MIT"
  13. demo = ""
  14. [extra.author]
  15. name = "doomy"
  16. homepage = "https://alexanderlozada.com"
  17. +++
  18. # feather
  19. A lightweight theme for zola
  20. Feather is a blog theme specifically designed for the static site generator [Zola](https://www.getzola.org/). It's as far as
  21. I know the first theme for the platform that isn't a port or just contained within template files.
  22. Feather is *not* intended for anything other than blogs.
  23. # Developing & Contributing
  24. Because feather comes with example content, you can run the theme just like any Gutenberg
  25. blog with `zola serve`. Your changes will autoreload!
  26. ## Considerations
  27. Please don't edit the `content` folder directly for your own blog, use it as a theme like
  28. intended!
  29. # Usage
  30. Using feather is easy. Install [Zola](https://www.getzola.org/) and follow
  31. [the guide for creating a site and using a theme](https://www.getzola.org/documentation/themes/installing-and-using-themes/). Then,
  32. add `theme = "feather"` to your `config.toml` file.
  33. If you intend to publish your site to Github Pages, please check out [this tutorial](http://vaporsoft.net/publishing-gutenberg-to-github/).
  34. ## Options
  35. Zola allows themes to [define `[extra]` variables](https://www.getzola.org/documentation/getting-started/configuration/)
  36. in the config. Here's a full list of theme variables with example values and comments.
  37. ```
  38. [extra]
  39. # specify an image for the big header at the top of the page.
  40. # this will be a background cover image, so make it large enough
  41. # so that it won't upscale enough to pixelate
  42. feather_header_image = "/theme_images/default.gif"
  43. # if you want comments, add your disqus embed code here.
  44. # you can obtain a code on the disqus website.
  45. feather_disqus_code = "<div id='disqus_thread'></div><script> var disqus_config = ... etc ... etc ..."
  46. # if you'd like people to be able to donate to you, you can include a donate link
  47. # to be displayed in the footer of the website.
  48. feather_donate_link = "https://paypal.me/piedoomy"
  49. # if you want analytics, add your tracking code HTML here.
  50. feather_analytics = "<script async src='https://www.googletagmanager.com/gtag/... etc ... etc ..."
  51. ```
  52. ## Features
  53. Feather also provides several features optional.
  54. - [x] Categories page
  55. - [x] Tags page
  56. - [x] Sorting chronologically
  57. - [x] Comments
  58. - [x] Analytics
  59. - [x] Donate links
  60. ## Using Categories and Tags
  61. In order to use categories and tags, you'll need to enable their compilation by adding the following lines to your `config.toml`
  62. (make sure they aren't under `[extra]`):
  63. ```toml
  64. generate_categories_pages = true
  65. generate_tags_pages = true
  66. ```
  67. # Live demo
  68. [My dev site](http://vaporsoft.net/) uses the latest version of feather.