1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<div align="center">
# hugo-profile
[](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fgurusabarish%2Fhugo-profile) [](https://github.com/gurusabarish/hugo-profile/network) [](https://github.com/gurusabarish/hugo-profile/stargazers)
</div>
A high performance and mobile first hugo template for personal portfolio and blog
## Requirements
- Hugo Version 0.68.0 or higher
## How to use this template
- [Hugo theme format](#Hugo-theme-format)
- [Local Development](#Local-Development)
- [Direct deployment using netlify](#Direct-deployment-using-netlify)
- [Direct deployment using Github Pages and action](#Direct-deployment-using-Github-Pages-and-action)
### Hugo theme format
- Install Hugo and create a site using `hugo new site my-site -f=yaml`
- Clone this repo inside your themes folder and create config.yaml (_I am not much aware about toml. So, I am using yaml format._) inside root folder and use one of these [v1config](https://github.com/gurusabarish/hugo-profile/blob/version3/exampleSite/v1.yaml), [v2config](https://github.com/gurusabarish/hugo-profile/blob/version3/exampleSite/v2.yaml), [v3config](https://github.com/gurusabarish/hugo-profile/blob/version3/exampleSite/v3.yaml) as base template.
```
cd themes
git clone https://github.com/gurusabarish/hugo-profile.git
```
- You should have the mentioned (_inside the config file_) images in static folder to use them.
### Local Development
- Install hugo and just clone this repo
```
git clone https://github.com/gurusabarish/hugo-profile.git
cd hugo-profile
```
- Now create config.yaml file in your root folder and use one of these [v1config](https://github.com/gurusabarish/hugo-profile/blob/version3/exampleSite/v1.yaml), [v2config](https://github.com/gurusabarish/hugo-profile/blob/version3/exampleSite/v2.yaml), [v3config](https://github.com/gurusabarish/hugo-profile/blob/version3/exampleSite/v3.yaml) as base template.
- Run your site using `hugo serve` commend
### Direct deployment using netlify
- Fork this repo or create new repo using `use this template` button and connect repo to netlify.
- You can customize the config file, content and everything inside exampleSite folder. Netlify will automatically deploy your changes every time you modify the repo.
**[What is netlify?](https://www.netlify.com/about/)** An intuitive Git-based workflow and powerful serverless platform to build, deploy, and collaborate on web apps
### Direct deployment using Github Pages and action
- Fork this repo or create new repo using `use this template` button. Github action will generate all files and push to demo branch. Now, you have to connect your github pages to that `demo` branch. _No need to create demo branch. Github action will take care of it_
- You can customize the config file, content and everything inside exampleSite folder. Github action will automatically deploy your changes to demo branch every time you modify the repo.
- When using your own domain create a file in the static dir called `CNAME' and put your domain in it.
- If you clone the repo locally, you can view the local change with `hugo --gc --minify --themesDir . serve` from within the exampleSite dir.
## 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 ⭐️ 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>
|
