163 lines
6.0 KiB
Markdown
163 lines
6.0 KiB
Markdown
# Ananke, A theme for [Hugo](http://gohugo.io/), a framework for building websites.
|
|
|
|
The intent of this theme is to provide a solid starting place for Hugo sites with basic features and include best practices for performance, accessibility, and rapid development.
|
|
|
|
|
|
|
|
[DEMO](https://gohugo-ananke-theme-demo.netlify.com/)
|
|
|
|
Features
|
|
|
|
- Responsive
|
|
- Accessible
|
|
- Contact form
|
|
- Custom Robots.txt (changes values based on environment)
|
|
- Internal templates for meta data, google analytics, and DISQUS comments
|
|
- RSS Discovery
|
|
- Table of Contents (must declare `toc: true` in post parameter)
|
|
|
|
Also includes examples of Hugo Features or Functions:
|
|
|
|
- Pagination (internal template)
|
|
- Taxonomies
|
|
- Archetypes
|
|
- Custom shortcode
|
|
- Related content
|
|
- Hugo built-in menu
|
|
- i18n
|
|
- `with`
|
|
- `HUGO_ENV`
|
|
- `first`
|
|
- `after`
|
|
- `sort`
|
|
- Site LanguageCode
|
|
- `where`
|
|
- Content Views
|
|
- Partials
|
|
- Template layouts (type "post" uses a special list template, single template, and a content view)
|
|
- Tags
|
|
- `len`
|
|
- Conditionals
|
|
- `ge` (greater than or equal to)
|
|
- `.Site.Params.mainSections` to avoid hard-coding "blog," etc. [[release note](https://github.com/spf13/hugo/blob/66ec6305f6cb450ddf9c489854146bac02f7dca1/docs/content/meta/release-notes.md#enhancements)]
|
|
|
|
|
|
This theme uses the "Tachyons" CSS library. This will allow you to manipulate the design of the theme by changing class names in HTML without touching the original CSS files. For more information see the [Tachyons website](http://tachyons.io/).
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
Inside the folder of your Hugo site run:
|
|
|
|
$ cd themes
|
|
$ git clone https://github.com/budparr/gohugo-theme-ananke.git
|
|
|
|
For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.
|
|
|
|
|
|
|
|
## Getting started
|
|
|
|
After installing the theme successfully it requires a just a few more steps to get your site running.
|
|
|
|
|
|
### The config file
|
|
|
|
Take a look inside the [`exampleSite`](https://github.com/budparr/gohugo-theme-ananke/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.toml`](https://github.com/budparr/gohugo-theme-ananke/blob/master/exampleSite/config.toml). To use it, copy the [`config.toml`](https://github.com/budparr/gohugo-theme-ananke/blob/master/exampleSite/config.toml) in the root folder of your Hugo site. Feel free to change the strings in this theme.
|
|
|
|
You may need to delete the line: `themesDir = "../.."`
|
|
|
|
|
|
### Add comments
|
|
|
|
To enable DISQUS comments, add `disqusShortname = YOURSHORTNAME` to your config file.
|
|
|
|
|
|
|
|
### Change the hero background
|
|
|
|
For any page or post you can add a featured image by including the local path in front matter (see content in the `exampleSite/content/_readme.md` file for examples): `featured_image: '/images/gohugo-default-sample-hero-image.jpg'`
|
|
|
|
If you would like to hide the header text on the featured image on a page, set `omit_header_text` to `true`. See `exampleSite/content/contact.md` for an example.
|
|
|
|
You don't need an image though. The default background color is black, but you can change the color, by changing the default color class in the config.toml file. Choose a background color from any on the [Tachyons](http://tachyons.io/docs/themes/skins/) library site, and preface it with "bg-"
|
|
|
|
example: `background_color_class = "bg-blue"` or `background_color_class = "bg-gray"`
|
|
|
|
|
|
|
|
### Activate the contact form
|
|
|
|
This theme includes a shortcode for a contact form that you can add to any page (there is an example on the contact page in the exampleSite folder). One option is to use [formspree.io](//formspree.io/) as proxy to send the actual email. Each month, visitors can send you up to one thousand emails without incurring extra charges. Visit the Formspree site to get the "action" link and add it to your shortcode like this:
|
|
|
|
```
|
|
{{< form-contact action="https://formspree.io/your@email.com" >}}
|
|
```
|
|
|
|
### Update font or body classes
|
|
|
|
The theme is set, by default, to use a near-white background color and the "Avenir" or serif typeface. You can change these in your config file with the `body_classes` parameter, like this:
|
|
|
|
```
|
|
[params]
|
|
body_classes = "avenir bg-near-white"
|
|
```
|
|
|
|
which will give you a body class like this:
|
|
|
|
```
|
|
<body class="avenir bg-near-white">
|
|
```
|
|
|
|
You can find a list of available typefaces [here](https://github.com/tachyons-css/tachyons/blob/v4.7.0/src/_font-family.css).
|
|
|
|
And a list of background colors [here](https://github.com/tachyons-css/tachyons/blob/v4.7.0/src/_skins.css#L96).
|
|
|
|
|
|
_n.b. in future versions we will likely separate the typeface and other body classes._
|
|
|
|
|
|
### Custom CSS
|
|
|
|
You can override the built-in css by using your own. Just put your own css files in the `static` directory of your website (the one in the theme directory also works but is not recommended) and modify the `custom_css` parameter in your config file. The path referenced in the parameter should be relative to the `static` folder. These css files will be added through the `header` partial after the built-in css file.
|
|
|
|
For example, if your css files are `static/css/custom.css` and `static/css/custom2.css` then add the following to the config file:
|
|
|
|
```
|
|
[params]
|
|
custom_css = ["css/custom.css","css/custom2.css"]
|
|
```
|
|
|
|
### Show Reading Time and Word Contributing
|
|
|
|
If you add a key of `show_reading_time` true to either the Config Params, a page or section's front matter, articles will show the reading time and word count.
|
|
|
|
|
|
### Nearly finished
|
|
|
|
In order to see your site in action, run Hugo's built-in local server.
|
|
|
|
`$ hugo server`
|
|
|
|
Now enter [`localhost:1313`](http://localhost:1313/) in the address bar of your browser.
|
|
|
|
## Production
|
|
|
|
To run in production (e.g. to have Google Analytics show up), run `HUGO_ENV=production` before your build command. For example:
|
|
|
|
```
|
|
HUGO_ENV=production hugo
|
|
```
|
|
|
|
## Contributing
|
|
|
|
If you find a bug or have an idea for a feature, feel free to use the [issue tracker](https://github.com/budparr/gohugo-theme-ananke/issues) to let me know.
|
|
|
|
|
|
|
|
|
|
TODO:
|
|
|
|
- fix hard-coded link to [section](https://github.com/budparr/gohugo-theme-ananke/blob/master/layouts/index.html#L32)
|