Files
cocoa-eh-hugo-theme/README.md
Nishanth Shanmugham 8e82ba2d21 Clean up
Finish updating example site
Edit README
2015-11-01 15:20:59 -06:00

68 lines
1.3 KiB
Markdown

# Cocoa
A consistent [Hugo](http://gohugo.io) theme with clear typograhy and colors.
<img src="" width="500px">
# Table of Contents
* [Getting Started](#getting-started)
* [Usage](#usage)
* [Screenshots](#screenshots)
* [Contributing](#contributing)
* [License](#license)
# Getting Started
From the root of your Hugo site, clone the theme into `themes/cocoa` by running:
````
git clone https://github.com/nishanths/cocoa-hugo-theme.git themes/cocoa
````
Then, generate your site's files by running:
````
hugo -t cocoa
````
# Usage
This section describes how to create content that works well with this theme.
## Example site
An example site is available under the `exampleSite/` directory.
## Creating Content
* Posts should go under a `content/posts` directory. Typically you would run:
````
hugo new posts/new-post.md
````
* Fixed pages such as an About page should preferably go under a `content/fixed` or be present at the root of the `contents` directory.
````
$ hugo new fixed/about.md
````
## Site variables
Please see the sample `config.toml` under the `exampleSite/` directory.
# Screenshots
<img src="" width="700px">
# Contributing
Pull requests are welcome!
# License
Licensed under the MIT License. See the [LICENSE](https://github.com/nishanths/cocoa-hugo-theme/blob/master/LICENSE.md) file for more details.