diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..b7c1df1 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,46 @@ +# Changelog + +> v0.6.0 + +- Add progressive loading of images +- Redesign image display +- Clean up a bit the example website + +> v0.5.0 + +- Add an automatic way to add sections +- Add the possibility to add a header to a section list page +- Add an automatic way to add single pages +- Group blog articles by month and year +- Add a homepage with the possibility of adding a small text and few articles +- Update hightlightjs to v9.9.0 +- Few deletions of obsolete lines + +> 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: . +* In the posts list, replaced date with bullets at smaller screen widths. + +> v0.1.0 + +* Initial release \ No newline at end of file diff --git a/README.md b/README.md index 5b000a3..0dedb7a 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,45 @@ # 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 is available [here](https://kodewolf.com). +[![MIT License](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000?style=plastic)](https://github.com/fuegowolf/cocoa-eh-hugo-theme/blob/master/LICENSE) -You can use this theme either for your blog or your personnal website. +**Cocoa Enhanced** is a clean and responsive [Hugo](http://gohugo.io) [theme](https://github.com/spf13/hugoThemes/) with cool typograhy. The main goal of this theme is to be simple but highly customizable. - +You can use this theme either for your blog or your personnal website. A demo is available [here](https://kodewolf.com). -# Table of Contents +> This is a fork from the original [Cocoa](https://www.github.com/nishanths/cocoa-hugo-theme) theme, with some improvements. + +[![screenshot](https://raw.githubusercontent.com/fuegowolf/cocoa-eh-hugo-theme/master/images/screenshot.png)](https://raw.githubusercontent.com/fuegowolf/cocoa-eh-hugo-theme/master/images/screenshot.png) + +## Table of Contents -* [Getting Started](#getting-started) * [Features](#features) -* [Usage](#usage) -* [Screenshots](#screenshots) -* [Changelog](#changelog) +* [Getting Started](#getting-started) * [Contributing](#contributing) * [License](#license) +## Features + +* Suited for blogging and personal webpages. +* Possibility to have sections with a header and a list of articles. +* Possibility to have single pages. +* Syntax highlighting with hightlightjs. +* Progressive images. +* Twitter cards support. +* Disqus support. +* Responsive and **blazing fast**. + +#### Differences from the original Cocoa + +This theme is less minimalist than the original Cocoa, with some new features : + +* Displays a logo on the side of the header, and there is a title different from the author name. +* Very modulable with sections and single pages. +* Group articles by month and year. +* Progressive images. +* Fonts are different : stronger and sharper, with a clear identity. +* The font size in articles is higher, the text justified and lines are more spaced. +* More features. + ## Getting Started From the root of your Hugo site, clone the theme into `themes/cocoa-eh` by running: @@ -30,162 +54,7 @@ Then, generate your site's files by running: hugo -t cocoa-eh ```` -If you want a simple blog you can just use the `exampleSite`, however if you desire a more -complex website you can build it with the [Usage](#usage) section. - -## Features - -* Responsive. -* Suited for blogging and personal webpages. -* Disqus support. -* Built-in support for 404 pages. -* Syntax highlighting with hightlightjs. -* Progressive images. -* Logo and title in the header for a clear identity. -* Possibility to have sections with a header and a list of articles. -* Possibility to have single pages. -* Twitter cards support - -#### Differences from the original Cocoa - -This theme is less minimalist than the original Cocoa, with some new features : - -* Displays a logo on the side of the header, and there is a title different from the author name. -* Very modulable with sections and single pages. -* Group articles by month and year. -* Progressive images. -* Fonts are different : stronger and sharper, with a clear identity. -* The font size in articles is higher, the text justified and lines are more spaced. -* On mobile : display the date next to article's titles. - -## 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) - -#### Blog posts - -The core of this theme is a **Blog**, but you can decide to not have this section if you want a personnal website for example. The last 5 months with articles will be displayed on the [homepage](#homepage), and all articles will be available in the `blog` section. - -If you want to add a blog section and a post, just type : - -```` -hugo new blog/your-new-post.md -```` - -#### Homepage - -The homepage is meant to display few articles or a description of yourself and the `home.md` post, which should be in the root of the folder. If you don't want to display something special on the front page, just don't create this file. If you want to add text before the article list : - -```` -hugo new home.md -```` - -#### Sections - -You can add **Sections** like Projects or Talks by adding a directory with the name of the section. They will be automatically in the header. - -* If you only want a list with articles, just create an article : - -```` -hugo new projects/my-project.md -```` - -* If you want to add a header to you section, with some markdown too, create an article with the same name as your section. - -```` -$ hugo new projects/projects.md -```` - -#### Single pages - -If you want to add a small page like an About one, just create an article in the root. It will be automatically added to the header too. - -```` -$ hugo new about.md -```` - -#### Progressive images - -You can activate the defering of images with this line in the `config.toml` : - -``` -progressively = true -``` - -And call images in markdown like usual : - -``` -![image](./images/image.jpg) -``` - -This will call the `./images/low/image.jpg` image and the `./images/high/image.jpg`. - -#### Twitter cards - -You can share your article on Twitter using the article link, and Twitter will show a summary card with the params of the post (`meta_img` is the image of the card) : - -``` -title = "Test title" -description = "Test description" -meta_img = "./images/high/test.jpg" -``` - -If you don't specify a meta image, it will take the global parameter `social_banner` in the `config.toml` : - -``` -social_banner = "img/banner.png" -``` - -## Changelog - -> v0.6.0 - -- Add progressive loading of images -- Redesign image display -- Clean up a bit the example website - -> v0.5.0 - -- Add an automatic way to add sections -- Add the possibility to add a header to a section list page -- Add an automatic way to add single pages -- Group blog articles by month and year -- Add a homepage with the possibility of adding a small text and few articles -- Update hightlightjs to v9.9.0 -- Few deletions of obsolete lines - -> 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: . -* In the posts list, replaced date with bullets at smaller screen widths. - -> v0.1.0 - -* Initial release +If you want a simple blog you can just use the `exampleSite`, however if you desire a more complex website you can build it with the [wiki](https://github.com/fuegowolf/cocoa-eh-hugo-theme/wiki). ## Contributing