diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 49 |
1 files changed, 29 insertions, 20 deletions
@@ -1,12 +1,15 @@ # Ezhil + Clean and minimal personal blog and portfolio theme for Hugo. -# Demo +## Demo + [View demo](https://ezhil-hugo.netlify.com/)  -# Features +## Features + * Clean and minimal * Responsive * Supports tags @@ -17,7 +20,8 @@ Clean and minimal personal blog and portfolio theme for Hugo. * Disqus comments * Hugo RSS feeds -# Installation +## Installation + From your Hugo site run the following. ```sh @@ -27,7 +31,8 @@ git clone https://github.com/vividvilla/ezhil.git For more information read the [official setup guide](https://gohugo.io/overview/installing/) of Hugo. -# Configuration +## Configuration + ```toml baseURL = "http://example.org/" languageCode = "en-us" @@ -44,17 +49,18 @@ googleAnalytics = "UA-123-45" # Your Disqus sortname. disqusShortname = "localhost" +# Number of posts to show in recent posts list (Optional). Defaults to 10. +paginate = 10 + [params] - # Blog subtitle which appears below blog title. Supports markdown. - subtitle = "Clean and minimal personal [blog theme for Hugo](https://github.com/vividvilla/ezhil)" - # Number of posts to show in recent posts list (Optional). Defaults to 10. - recentPostsCount = 10 - # Content types which are excluded from recent posts and archive page (Optional). Defaults to ["page"] - excludedTypes = ["page"] - # Content types which are excludes Disqus comments (Optional). Defaults to ["page"] - disableDisqusTypes = ["page"] - # If social media links are enabled then enable this to fetch icons from CDN instead of hosted on your site. - featherIconsCDN = true + # Blog subtitle which appears below blog title. Supports markdown. + subtitle = "Clean and minimal personal [blog theme for Hugo](https://github.com/vividvilla/ezhil)" + # Content types which are included in home page recent posts list. + mainSections = ["posts"] + # Content types which are excludes Disqus comments. + disableDisqusTypes = ["page"] + # If social media links are enabled then enable this to fetch icons from CDN instead of hosted on your site. + featherIconsCDN = true # Main menu which appears below site header. [[menu.main]] @@ -94,10 +100,11 @@ url = "https://twitter.com/gohugoio" tag = "tags" ``` -# Content type -You can specify content type with field `type` in your content. For example static pages can be set as type `page` which are excluded from recent posts and all posts page. You can use site params `excludedTypes` and `disableDisqusTypes` to control which page types are excluded from recent posts and Disqus comments respectively. +## Content type -``` +You can specify content type with field `type` in your content. For example static pages can be set as type `page` which are excluded from recent posts and all posts page. You can use site params `mainSections` and `disableDisqusTypes` to control which page types are excluded from recent posts and Disqus comments respectively. + +```md --- title: "About" date: 2019-04-19T21:37:58+05:30 @@ -107,10 +114,11 @@ type: "page" This is some static page where you can write about yourself. ``` -# Disable Disqus +## Disable Disqus + You can disable Disqus from contents selectively or for all contents with certain content type. Use content field `disqus` to disable Disqus from certain contents. -``` +```md --- title: "Content without comments" date: 2019-04-19T21:37:58+05:30 @@ -122,6 +130,7 @@ This is a content without Disqus comments. You can also disable Disqus for certain content types by using site param `disableDisqusTypes`. You can check config section above for example. -# Credits +## Credits + * [Feather Icons](https://feathericons.com/) * [Zen habits](https://zenhabits.net/) for demo content |