Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/roperzh/tinyce-hugo-theme
Simple blog theme for hugo http://roperzh.github.io/tinyce-hugo-theme/
https://github.com/roperzh/tinyce-hugo-theme
Last synced: about 2 months ago
JSON representation
Simple blog theme for hugo http://roperzh.github.io/tinyce-hugo-theme/
- Host: GitHub
- URL: https://github.com/roperzh/tinyce-hugo-theme
- Owner: roperzh
- License: mit
- Created: 2014-08-08T22:40:48.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2018-04-26T20:25:55.000Z (over 6 years ago)
- Last Synced: 2024-08-01T12:18:39.462Z (4 months ago)
- Language: CSS
- Homepage:
- Size: 1.11 MB
- Stars: 8
- Watchers: 1
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- awesome-starred - roperzh/tinyce-hugo-theme - Simple blog theme for hugo http://roperzh.github.io/tinyce-hugo-theme/ (others)
README
Tinyce
===
Tinyce is a general-purpose [Hugo](http://hugo.spf13.com) theme.
You can check the live version [here](http://roperzh.github.io/tinyce-hugo-theme/).
Getting started
===
Once you have Hugo up and running, you must:
Create a Hugo project:
```bash
$ hugo new site my-site
```
And then install tinyce:
```bash
$ cd themes
$ git clone https://github.com/roperzh/tinyce-hugo-theme
```
*If you are using Hugo v0.11 or below, please read [this](https://github.com/roperzh/tinyce-hugo-theme/#usage-with-hugo-v011-and-below)*
Now you can set tinyce as the default theme for your site by adding this line
in the `config` file:
```toml
theme = "tinyce-hugo-theme"
```
Or you can start the server with:
```bash
hugo server --theme=tinyce-hugo-theme --buildDrafts --watch
```
Setting Variables
===
Tinyce needs a custom archetype in order to work properly, behind the covers
you will only need to define two new variables in the front matter section of
your contents.
- **color** : the color associated with the post, valid colors are: `red`,
`green`, `blue`, `yellow`, `orange` and `gray`.
- **icon** : a valid font-awesome icon name, without the `fa-` prefix. For example,
instead of `fa-heart`, you only need to put `heart`. [here](http://fortawesome.github.io/Font-Awesome/cheatsheet/)
is a cheatsheet of valid icons.
***Example***
```toml
+++
Categories = ["Development", "GoLang"]
Description = "My short description"
Tags = ["Development", "golang"]
color = "green"
icon = "heart"
title = "Go is cool"
date = 2014-08-09T05:04:40Z
+++
```
Usage with Hugo v0.11 and below
===
The latest version of the theme includes some features bundled with Hugo v0.12,
if you are using an old version, please install tinyce like this:
```bash
$ cd themes
$ git clone https://github.com/roperzh/tinyce-hugo-theme
$ cd tinyce-hugo-theme
$ git checkout 08a497
```
That's it!
Contributing
===
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request