docs

2022-03-24 18:42:53 +05:30
parent 47bde42590
commit 708d0a0022
9 changed files with 109 additions and 108 deletions
@@ -1,55 +1,81 @@
 # Hugo Profile

-# Navy Variant
-#### Demo: [here](./docs/demos/navyVariant/gif.gif)
-```yaml
-color:
-    textColor: "#F5F5F5"
-    secondaryTextColor: "#F5F5F5"
-    backgroundColor: "#313552"
-    primaryColor: "#F1E0AC"
-    secondaryColor: "#30475E"
-```
+[![Twitter](https://img.shields.io/twitter/url?label=Tweet&style=social&url=https%3A%2F%2Fgithub.com%2Fgurusabarish%2Fhugo-profile)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fgurusabarish%2Fhugo-profile) [![GitHub forks](https://img.shields.io/github/forks/gurusabarish/hugo-profile?style=plastic)](https://github.com/gurusabarish/hugo-profile/network) [![GitHub stars](https://img.shields.io/github/stars/gurusabarish/hugo-profile?style=plastic)](https://github.com/gurusabarish/hugo-profile/stargazers)

-# Blue Variant
-#### Demo: [here](./docs/demos/blueVariant/gif.gif)
-```yaml
-color:
-    textColor: "#2C3333"
-    secondaryTextColor: "#F5F5F5"
-    backgroundColor: "#54BAB9"
-    primaryColor: "#F0F0F0"
-    secondaryColor: "#78C2C3"
-```
+[![Netlify Status](https://api.netlify.com/api/v1/badges/5c1dcb34-cada-4c80-82b7-cfdbdbd7c774/deploy-status)](https://app.netlify.com/sites/hugo-profile/deploys)
+![Latest Release](https://img.shields.io/github/v/release/gurusabarish/hugo-profile?include_prereleases)
+![Last Commit](https://img.shields.io/github/last-commit/gurusabarish/hugo-profile)
+![Open Issues](https://img.shields.io/github/issues/gurusabarish/hugo-profile?color=important)
+![Open Pull Requests](https://img.shields.io/github/issues-pr/gurusabarish/hugo-profile?color=yellowgreen)
+![License](https://img.shields.io/github/license/gurusabarish/hugo-profile)

-# Red Variant
-#### Demo: [here](./docs/demos/redVariant/gif.gif)
-```yaml
-color:
-    textColor: "#121212"
-    secondaryTextColor: "#311D3F"
-    backgroundColor: "#FF6363"
-    primaryColor: "#30475E"
-    secondaryColor: "#F05454"
-```
+A high performance and mobile first hugo template for personal portfolio and blog

-# Green Variant
-#### Demo: [here](./docs/demos/greenVariant/gif.gif)
-```yaml
-color:
-    textColor: "#161616"
-    secondaryTextColor: "#311D3F"
-    backgroundColor: "#34BE82" 
-    primaryColor: "#194350"
-    secondaryColor: "#2FDD92"
+- Example Site: [hugo-profile.netlify.app](https://hugo-profile.netlify.app)
+
+# Features
+- Fully Responsive
+- Minimalist Design
+- SEO Friendly.
+- Light/Dark/auto
+- Taxonomies
+- [Color customization](https://github.com/gurusabarish/hugo-profile/wiki/Color-Customization)
+- Analytics Support 
+  - [Google Analytics](https://gohugo.io/templates/internal/#google-analytics)
+- Comment Support
+  - [Disqus](https://gohugo.io/content-management/comments/)
+
+Technology used: Bootstrap, fontawesome 
+
+# Requirements
+- Hugo Version 0.87.0 or higher
+
+
+# How to use this template
+
+- [Hugo theme](#Hugo-theme)
+- [Direct deployment using netlify](#Direct-deployment-using-netlify)
+
+[For more details](https://github.com/gurusabarish/hugo-profile/wiki)
+## Hugo theme
+
+- Install Hugo and create a site using `hugo new site my-site -f=yaml`
+- Clone this repo inside your themes folder
 ```
-# Pink Variant
-#### Demo: [here](./docs/demos/pinkVariant/gif.gif)
-```yaml
-color:
-    textColor: "#D1D1D1"
-    secondaryTextColor: "#C1A3A3"
-    backgroundColor: "#470D21"
-    primaryColor: "#F3F0D7"
-    secondaryColor: "#781D42"
-```
+cd themes
+git clone https://github.com/gurusabarish/hugo-profile.git
+```
+- Create config.yaml (you can use `config.toml` too) inside root folder 
+- Setup the configurations in `config.yaml`. [reference](https://github.com/gurusabarish/hugo-profile/blob/master/exampleSite/config.yaml)
+- You should have the mentioned (_inside the config file_) images in static folder to use them.
+
+For more details: [Hugo's official docs](https://gohugo.io/getting-started/quick-start/), [content management](https://www.mikedane.com/static-site-generators/hugo/content-organization/)
+
+## Direct deployment using netlify
+
+- Fork this repo or create new repo using `use this template` button and connect repo to netlify.
+- whenever you customize the files exampleSite folder, netlify will automatically deploy your changes.
+
+For more details: [host on netlify](https://gohugo.io/hosting-and-deployment/hosting-on-netlify/), [content management](https://www.mikedane.com/static-site-generators/hugo/content-organization/)
+
+# Deployment
+
+Run `hugo`. It will generate a folder called public. You can use the files inside public folder for deployment. You should delete the public folder for each time when you are using `hugo` commend.
+
+# Issues
+
+If you have a question, please [open an issue](https://github.com/gurusabarish/hugo-profile/issues) for help and to help those who come after you. The more information you can provide, the better!
+
+# Contributing
+
+Contributions, issues, and feature requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
+
+# License
+
+Licensed under [MIT](LICENSE)
+
+# 🤝 Support
+
+Give a ⭐️ or buy me a ~`coffee`~ tea if you like this project!
+
+<a href="https://www.buymeacoffee.com/gurusabarish" target="_blank" rel="noopener"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="40" width="145" alt="Buy Me A Coffee"></a>