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.

54 lines
2.6 KiB

10 years ago
9 years ago
9 years ago
9 years ago
  1. # Cactus Theme
  2. Toasted Cactus is a really minimalistic theme for bloggers based on [Cactus for Hugo](https://github.com/digitalcraftsman/hugo-cactus-theme).
  3. Tracking code, sharing, disqus and highlight.js were removed, resulting in a base design < 5kb minified and gzipped.
  4. ![Screenshot](https://raw.githubusercontent.com/digitalcraftsman/hugo-cactus-theme/dev/images/screenshot.png)
  5. ## Installation
  6. Inside the folder of your Hugo site run:
  7. $ cd themes
  8. $ git clone https://git.webschneider.org/schneider/toasted-cactus
  9. For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
  10. ### The config file
  11. Take a look inside the [`exampleSite`](//github.com/digitalcraftsman/hugo-cactus-theme/tree/dev/exampleSite) folder of this theme. You'll find a file called [`config.toml`](//github.com/digitalcraftsman/hugo-cactus-theme/blob/dev/exampleSite/config.toml).
  12. To use it, copy the [`config.toml`](//github.com/digitalcraftsman/hugo-cactus-theme/blob/dev/exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change strings as you like to customize your website.
  13. Make sure to update the `themesDir` property in the config file to point to your site's theme folder otherwise an error will be thrown indicating the themes folder is unable to be found.
  14. ## About page
  15. Use the about page to introduce yourself to your visitors. You can customize the content as you like in the [`config.toml`](//github.com/digitalcraftsman/hugo-cactus-theme/blob/dev/exampleSite/config.toml). Furthermore, you should replace the [avatar placeholder](//github.com/digitalcraftsman/hugo-cactus-theme/blob/master/static/images/avatar.png) with a great image of yourself.
  16. ## Hide pages
  17. Pages can be hidden and don't appear in the post list on the homepage if you add the variable `hidden = true` to the frontmatter. This allows you to link from elsewhere, i.e. just the menu.
  18. ## Nearly finished
  19. In order to see your site in action, run Hugo's built-in local server.
  20. $ hugo server
  21. Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser.
  22. ## License
  23. This theme is released under the MIT license. For more information read the [license](https://git.webschneider.org/schneider/toasted-cactus/src/master/LICENSE.md).
  24. ## Acknowledgements
  25. Thanks to
  26. - [digitalcraftsman](https://github.com/digitalcraftsman) for porting the Cactus theme
  27. - [Nick Balestra](https://github.com/nickbalestra/kactus) for creating the original theme
  28. - [Steve Francia](https://github.com/spf13) for creating Hugo and the awesome community around the project.