mirror of
https://github.com/Noettore/cocoa-eh-hugo-theme.git
synced 2025-10-15 19:56:41 +02:00
113 lines
3.1 KiB
Markdown
113 lines
3.1 KiB
Markdown
# Cocoa Enhanced
|
|
|
|
A consistent and responsive [Hugo](http://gohugo.io) [theme](https://github.com/spf13/hugoThemes/) with clean typograhy. This is a fork from the original [Cocoa](https://www.github.com/nishanths/cocoa-hugo-theme) theme, with some improvements.
|
|
|
|
A [Demo](https://kodewolf.com) is available.
|
|
|
|
#### Features
|
|
|
|
* Responsive
|
|
* Suited for blogging and personal webpages
|
|
* Disqus support
|
|
* Built-in support for 404 pages
|
|
* Syntax highlighting
|
|
* Can display a logo
|
|
|
|
<img src="/images/screenshot.png" width="800">
|
|
|
|
# Table of Contents
|
|
|
|
* [Getting Started](#getting-started)
|
|
* [Usage](#usage)
|
|
* [Screenshots](#screenshots)
|
|
* [Changelog](#changelog)
|
|
* [Contributing](#contributing)
|
|
* [License](#license)
|
|
|
|
## Getting Started
|
|
|
|
From the root of your Hugo site, clone the theme into `themes/cocoa-eh` by running:
|
|
|
|
````
|
|
git clone https://github.com/fuegowolf/cocoa-eh-hugo-theme.git themes/cocoa-eh
|
|
````
|
|
|
|
Then, generate your site's files by running:
|
|
|
|
````
|
|
hugo -t cocoa-eh
|
|
````
|
|
|
|
## Usage
|
|
|
|
#### config.toml
|
|
|
|
Please see the sample [`config.toml`](https://github.com/fuegowolf/cocoa-eh-hugo-theme/blob/master/exampleSite/config.toml) in `exampleSite/`.
|
|
|
|
Note that if you already use cocoa but have updated to Hugo 0.18, you must lowercase every params of your existing `config.toml`. (like in the sample)
|
|
|
|
#### Creating Content
|
|
|
|
* Posts should generally go under a `content/blog` directory. Typically you would run:
|
|
|
|
````
|
|
hugo new blog/your-new-post.md
|
|
````
|
|
|
|
You may need to set `draft = false` in the new post's front matter for it to appear on your site.
|
|
|
|
* 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
|
|
````
|
|
|
|
#### Example site
|
|
|
|
An example site is available in `exampleSite/`.
|
|
|
|
## Changelog
|
|
|
|
> v0.4.0
|
|
|
|
- Add logo and a title in header instead of only the author name
|
|
- Change pages from the navigation
|
|
- Delete useless icons from the bottom
|
|
- Change fonts and style the text (font size, justify ...)
|
|
- Improve mobile design by adding dates, removing grey background and adapt font
|
|
|
|
And more.
|
|
|
|
> v0.3.0
|
|
|
|
- Change color from orange to blue; improve colors elsewhere
|
|
- Change `div.section` to `section`
|
|
- Rename `posts` directory to `blog`
|
|
- Add ability to specify extra CSS files in `config.toml`
|
|
- Removed `WebFontsFile` feature from `config.toml`
|
|
- Remove the initials displayed on top right of single post pages
|
|
- Update example site
|
|
|
|
> v0.2.0
|
|
|
|
* Added Disqus support. To enable Disqus, add `disqusshortname = "XYZ"` to `config.toml`. More details: <http://gohugo.io/extras/comments/>.
|
|
* In the posts list, replaced date with bullets at smaller screen widths.
|
|
|
|
> v0.1.0
|
|
|
|
* Initial release
|
|
|
|
## Contributing
|
|
|
|
Pull requests, bug fixes, and new features are welcome!
|
|
|
|
1. Fork the repository
|
|
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 on GitHub
|
|
|
|
## License
|
|
|
|
Licensed under the MIT License. See the [LICENSE](https://github.com/fuegowolf/cocoa-eh-hugo-theme/blob/master/LICENSE.md) file for more details.
|