diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 73 |
1 files changed, 63 insertions, 10 deletions
@@ -1,19 +1,72 @@ -# Cayman theme +# Cayman -Cayman is a clean, responsive theme for [GitHub Pages](https://pages.github.com). This theme is available as an option if you use the [Automatic Page Generator](https://help.github.com/articles/creating-pages-with-the-automatic-generator/) or you can copy the template and styles to use on your own. +**TODO** netlify status badge -You can preview the theme at http://jasonlong.github.io/cayman-theme or with real content at http://jasonlong.github.io/geo_pattern. +Cayman is a clean, responsive theme for Hugo, ported from the original Jekyll Caymen Theme. - +## Table of contents -# Customizations +- [Demo](#demo) +- [Minimum Hugo version](#minimum-hugo-version) +- [Installation](#installation) +- [Updating](#updating) +- [Run example site](#run-example-site) +- [Configuration](#configuration) +- [Favicons](#favicons) +- [Getting help](#getting-help) +- [Credits](#credits) +- [License](#license) -If you copy this theme for your own needs, feel free to customize the colors however you like. A couple of nice sources for gradient colors are http://uigradients.com and http://jxnblk.com/shade/. +## Demo -# Using with Jekyll +**TODO** demo link -If you'd like to use this theme with Jekyll, Pietro Menna has put together a package to make it easy. You can find it at https://github.com/pietromenna/jekyll-cayman-theme +## Minimum Hugo version -# License +Hugo version `0.48` or higher is required. View the [Hugo releases](https://github.com/gohugoio/hugo/releases) and download the binary for your OS. -This work is licensed under a [Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/) license. +## Installation + +From the root of your site: + +``` +git submodule add https://github.com/zwbetz-gh/cayman-hugo-theme.git themes/cayman-hugo-theme +``` + +## Updating + +From the root of your site: + +``` +git submodule update --remote --merge +``` + +## Run example site + +From the root of `themes/cayman-hugo-theme/exampleSite`: + +``` +hugo server --themesDir ../.. +``` + +## Configuration + +Copy the `config.toml` or `config.yaml` from the **TODO** example site, then edit as desired. + +If you copy this theme for your own needs, feel free to customize the colors however you like. A couple of nice sources for gradient colors are http://uigradients.com and http://jxnblk.com/shade/. **TODO** explain how to do this, and see http://uigradients.com + +## Favicons + +Upload your image to [RealFaviconGenerator](https://realfavicongenerator.net/) then copy-paste the generated favicon files under `static`. + +## Getting help + +If you run into an issue that isn't answered by this documentation or the **TODO** example site, then visit the [Hugo forum](https://discourse.gohugo.io/). The folks there are helpful and friendly. **Before** asking your question, be sure to read the [requesting help guidelines](https://discourse.gohugo.io/t/requesting-help/9132). Feel free to tag me in your question, my forum username is [@zwbetz](https://discourse.gohugo.io/u/zwbetz/summary). + +## Credits + +Thank you to [Jason Long](https://github.com/jasonlong) for creating the original Jekyll [Cayman Theme](https://github.com/jasonlong/cayman-theme). + +## License + +[Creative Commons Attribution 4.0 International](http://creativecommons.org/licenses/by/4.0/). |