Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
behdad222 committed Jul 3, 2020
1 parent 2cb4937 commit 4a939d0
Showing 1 changed file with 10 additions and 98 deletions.
108 changes: 10 additions & 98 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,26 @@
# Ezhil

Clean and minimal personal blog and portfolio theme for Hugo.

## Demo

[View demo](https://ezhil-hugo.netlify.com/)

![Screenshot](images/screenshot-light.png "Ezhil light theme")
![Screenshot](images/screenshot-dark.png "Ezhil dark theme")
# Tehlug Hugo Theme

## Features

* Clean and minimal
* Dark mode (Auto detect from OS)
* Responsive
* Supports tags
* Social media links
* Google Analytics integration
* Syntax highlighting
* Twitter cards and opengraph tags support
* Disqus comments
* Hugo RSS feeds
* Custom CSS/JS
* Show location in map
* Open lat,lng
* Show register link
* Make Gallery

## Installation

From your Hugo site run the following.

```sh
cd themes
git clone https://github.com/vividvilla/ezhil.git
git clone https://github.com/tehlug/Tehlug-Hugo-Theme
```

For more information read the [official setup guide](https://gohugo.io/overview/installing/) of Hugo.
Expand All @@ -38,9 +29,9 @@ For more information read the [official setup guide](https://gohugo.io/overview/

```toml
baseURL = "http://example.org/"
languageCode = "en-us"
languageCode = "fa-ir"
title = "My personal blog"
theme = "ezhil"
theme = "Tehlug-Hugo-Theme"

copyright = "© Copyright notice"

Expand All @@ -49,11 +40,6 @@ pygmentsstyle = "solarized-dark"
pygmentscodefences = true
pygmentscodefencesguesssyntax = true

# Your Google analytics code.
googleAnalytics = "UA-123-45"
# Your Disqus sortname.
disqusShortname = "localhost"

# Number of posts to show in recent posts list (Optional). Defaults to 10.
paginate = 10

Expand All @@ -62,17 +48,11 @@ summaryLength = 20

[params]
# Blog subtitle which appears below blog title. Supports markdown.
subtitle = "Clean and minimal personal [blog theme for Hugo](https://github.com/vividvilla/ezhil)"
subtitle = "Clean and minimal personal [blog theme for Hugo](https://github.com/tehlug/Tehlug-Hugo-Theme)"

# 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

# Specify favicon (icons/i.png maps to static/icons/i.png). No favicon if not defined.
favicon = "icons/myicon.png"

Expand All @@ -92,75 +72,7 @@ summaryLength = 20
# for example you may want to include external JS library.
customJS = ["js/abc.js", "js/xyz.js", "https://code.jquery.com/jquery-3.4.1.js"]

# Main menu which appears below site header.
[[menu.main]]
name = "Home"
url = "/"
weight = 1

[[menu.main]]
name = "All posts"
url = "/posts"
weight = 2

[[menu.main]]
name = "About"
url = "/about"
weight = 3

[[menu.main]]
name = "Tags"
url = "/tags"
weight = 4

# Social media links which shows up on site header.
# Uses feather icons for icons. You can [search icon names from here](https://feathericons.com/).
[[params.social]]
name = "Github"
icon = "github"
url = "https://github.com/vividvilla/ezhil"

[[params.social]]
name = "Twitter"
icon = "twitter"
url = "https://twitter.com/gohugoio"

# Enable tags.
[taxonomies]
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 `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
type: "page"
---

This is some static page where you can write about yourself.
```

## Disable Disqus

You can disable Disqus site wide if you don't set `DisqusShortname` param in config. You can also 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
disqus: false
---

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

* [Feather Icons](https://feathericons.com/)
* [Zen habits](https://zenhabits.net/) for demo content
```

0 comments on commit 4a939d0

Please sign in to comment.