An open API service indexing awesome lists of open source software.

https://github.com/scorphus/hugo-theme-crispy


https://github.com/scorphus/hugo-theme-crispy

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# Crispy

A theme based on **Crisp** – see below. Updated documentation to follow soon.

## Dependencies

### [minify](https://github.com/tdewolff/minify/tree/master/cmd/minify)

`make setup`

## Crisp

A minimalist, responsive, and open-source theme for [Hugo](http://gohugo.io/) by [Kathy Qian](http://kathyqian.com).

![Index](https://raw.github.com/kathyqian/crisp-ghost-theme/master/screenshots/index.png)

### Enabling Disqus comments
This theme requires a variable called 'disqus' to be defined in your **config.toml** for your Hugo site.

Make sure that the variable 'disqus' is defined in the 'Params' section, like so:

```
[Params]

disqus = "replace-this-with-your-disqus-shortname"
```

### Editing Follow Buttons

Crisp uses Font Awesome for icons. See the Font Awesome documentation for the [full list of icons](http://fortawesome.github.io/Font-Awesome/icons/) and [usage tips](http://fortawesome.github.io/Font-Awesome/examples/).

I have placed some common buttons in **follow.hbs**, with more options in the commented out sections. Make sure to replace the `username` in the URLs so the links point to your profiles.

### Features, Changelog, and Technical Notes

Please see the [wiki](https://github.com/kathyqian/crisp-ghost-theme/wiki/) for details regarding previous releases.

### Credits

[Kathy Qian](http://kathyqian.com) for its initial Ghost theme.

Many thanks to [@davegandy](http://twitter.com/davegandy) for the [Font Awesome](https://github.com/FortAwesome/Font-Awesome) icons used throughout the theme.

Social sharing buttons are a modified version of the [Ridiculously Responsive Social Sharing Buttons](https://github.com/kni-labs/rrssb) by [@dbox](http://www.twitter.com/dbox) and [@seagoat](http://www.twitter.com/seagoat). Great job, guys!

### License

This theme is licensed under the [Creative Commons Attribution-ShareAlike 4.0 International](http://creativecommons.org/licenses/by-sa/4.0/) license. Go crazy on the customizations, distribute to your friends, just give me some credit. Feel free to modify the footer text, though I would really appreciate it if you could keep at least one of the links intact.

### Caution

Related documents only works with my Hugo fork [zenithar/hugo](https://github.com/zenithar/hugo).

### More Screenshots

![Post](https://raw.github.com/kathyqian/crisp-ghost-theme/master/screenshots/post.png)
![Comments](https://raw.github.com/kathyqian/crisp-ghost-theme/master/screenshots/post-2.png)