readme update

This commit is contained in:
gurusabarish
2021-03-16 20:07:32 +05:30
parent 98ca5e1afa
commit 6cd2d85086
2 changed files with 7 additions and 82 deletions
+7 -82
View File
@@ -1,11 +1,9 @@
<div align="center"> <div align="center">
# hugo-profile (100% performance) # hugo-profile
![visitors](https://visitor-badge.glitch.me/badge?page_id=https://github.com/gurusabarish/hugo-profile) A high performance hugo theme for personal portfolio and blog
A simple hugo theme for personal portfolio
[![LICENSE](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/gurusabarish/hugo-profile/blob/master/LICENSE) [![LICENSE](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/gurusabarish/hugo-profile/blob/master/LICENSE)
[![lighthouse score](https://img.shields.io/static/v1?label=Lighthouse%20Score&message=Good&color=green)](https://hugo-profile.netlify.app/) [![lighthouse score](https://img.shields.io/static/v1?label=Lighthouse%20Score&message=Good&color=green)](https://hugo-profile.netlify.app/)
@@ -14,30 +12,25 @@ A simple hugo theme for personal portfolio
## Queries ## Queries
- If you have any queries or bugs, feel free to open an issue in [github](https://github.com/gurusabarish/hugo-profile/issues) - If you have any queries or bugs, feel free to open an issue in [github](https://github.com/gurusabarish/hugo-profile/issues)
- Join our community for further updates: [hugo-profile](https://discord.gg/zgTajK4)
## Performance of the website (100) ## Performance of the website (100)
- [Lighthouse performance (100)](https://lighthouse-dot-webdotdevsite.appspot.com//lh/html?url=https%3A%2F%2Fhugo-profile.netlify.app%2F) - [Lighthouse performance (100)](https://lighthouse-dot-webdotdevsite.appspot.com//lh/html?url=https%3A%2F%2Fhugo-profile.netlify.app%2F)
- [Google pagespeed insights (100)](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fhugo-profile.netlify.app%2F&tab=desktop) - [Google pagespeed insights (100)](https://developers.google.com/speed/pagespeed/insights/?url=https%3A%2F%2Fhugo-profile.netlify.app%2F&tab=desktop)
![High performance of the hugo-profile theme](https://raw.githubusercontent.com/gurusabarish/hugo-profile/master/images/100.png)
## Demo ### [Demo Site](https://hugo-profile.netlify.app)
![Thumpnail](https://github.com/gurusabarish/hugo-profile/blob/master/images/tn.png) *NOTE: If you are using this site as a template for your own portfolio and blog, I would be very glad if you add a link to the original template in footer*
### Demo Site: [Hugo-profile (100)](https://hugo-profile.netlify.app)
*NOTE: If you are using this site as a template for your own portfolio and blog, I would be very glad if you add a link to the original site with my name in footer*
## Features ## Features
- High(100) performance - High performance
- Minimalist Design - Minimalist Design
- Fully Responsive - Fully Responsive
- Google Analytics Support - Google Analytics Support
- Disqus Comment Support - Disqus Comment Support
> Open an issue and give some feedbacks, feature requests. It will help us to make the better version.
## Requirements ## Requirements
@@ -68,75 +61,8 @@ git clone https://github.com/gurusabarish/hugo-profile.git
## Configuration ## Configuration
Configure your `config.yaml` file of your site as below: Configure your `config.yaml` file of your site as [here](https://github.com/gurusabarish/hugo-profile/blob/master/exampleSite/config.yaml):
```
baseURL: "https://example.com"
languageCode: "en-us"
title: "Hugo-profile"
theme: "hugo-profile"
googleanalytics: UA-xxxxxxxx-x
disqusShortname: yourdisqusname
Paginate: 3
taxonomies:
tag: "tags"
category: "categories"
params:
favicon: ""
description: "A high performance hugo theme for personal website. It is single page portfolio. It has blog."
copyright: "2020"
# Navbar Menus
customMenus:
- name: "Blog"
Url: "/blog"
# social
name: "Hugo-profile"
github: "https://github.com"
linkedin: "https://linkedin.com"
twitter: "https://twitter.com"
instagram: "https://instagram.com"
facebook: "https://facebook.com"
# About
profile_image: ""
descripe_l1_person: "A high performance hugo theme for personal website and blog. It is a single page portfolio."
descripe_l2_person: "This is just a example for about section. You can easily change with the help of cofig file."
job: "Your job"
useresume: true
resume: ""
# Things I do
usedothings: true
Things:
- logo: fab fa-python
title: Python
description: I build something beautiful using Python.
- logo: fas fa-robot
title: Machine learning
description: I train robust models for various tasks.
- logo: fab fa-html5
title: Things for web
description: I love to build things for web
#blog ( Description for seo. If you want to show description in your blog post, let's make it true)
showdescription: true
Author:
name: "Gurusabarish"
website: "https://github.com/gurusabarish"
```
<b>Use Yaml as config file</b>
You can just copy the content for `config.yaml` files from `theme/toha/exampleSite/config.yaml`.
## Archetypes support ## Archetypes support
``` ```
@@ -162,4 +88,3 @@ description: ""
## Contributing ## Contributing
> Contributers are always welcome :heart: > Contributers are always welcome :heart:
BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB