2 Commits

Author SHA1 Message Date
gurusabarish 8e608c1cc2 readme update 2022-03-23 06:28:13 +05:30
gurusabarish 7676361983 v3 2022-03-23 06:15:47 +05:30
29 changed files with 15 additions and 157 deletions
-38
View File
@@ -1,38 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
**Additional context**
Add any other context about the problem here.
-10
View File
@@ -1,10 +0,0 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''
---
-20
View File
@@ -1,20 +0,0 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
-19
View File
@@ -1,19 +0,0 @@
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 120
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 30
# Issues with these labels will never be considered stale
exemptLabels:
- Keep
# Label to use when marking an issue as stale
staleLabel: Stale
# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity.
If this is a **bug** and you can still reproduce this error on the <code>master</code> branch, please reply with all of the information you have about it in order to keep the issue open.
If this is a **feature request**, and you feel that it is still relevant and valuable, please tell us why.
This issue will automatically be closed in the near future if no further activity occurs. Thank you for all your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
-36
View File
@@ -1,36 +0,0 @@
name: Deployment
on:
push:
branches:
- master
workflow_dispatch:
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
submodules: true
fetch-depth: 0
- name: Install Hugo
uses: peaceiris/actions-hugo@v2
with:
hugo-version: "0.79.0"
- name: Build
run: cd website && hugo --gc --minify --themesDir .
- name: Deploy website to the branch
uses: peaceiris/actions-gh-pages@v3
with:
personal_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./website/public
#external_repository: gurusabarish/hugo-profile-demo
publish_branch: demo
user_name: hugo-profile bot
user_email: githubactionsbot@users.noreply.github.com
+5 -24
View File
@@ -4,29 +4,10 @@
[![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)
[![Netlify Status](https://api.netlify.com/api/v1/badges/5c1dcb34-cada-4c80-82b7-cfdbdbd7c774/deploy-status)](https://app.netlify.com/sites/hugo-profile/deploys)
![Repository Size](https://img.shields.io/github/repo-size/gurusabarish/hugo-profile)
![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)
</div>
A high performance and mobile first hugo template for personal portfolio and blog
### Credit
I spent an amount of effort building this template. It's always disheartening whenever I find that someone use this template without giving me credit. Please, give me proper credit in footer.
### Demo
- [Live demo V1](https://hugo-profile-1.netlify.app)
- [Live demo V2](https://hugo-profile-2.netlify.app)
- [Live demo V3 (latest)](https://hugo-profile.netlify.app)
- [Github pages demo](https://gurusabarish.github.io/hugo-profile)
## Requirements
- Hugo Version 0.68.0 or higher
@@ -41,7 +22,7 @@ I spent an amount of effort building this template. It's always disheartening wh
### 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/master/website/v1.yaml), [v2config](https://github.com/gurusabarish/hugo-profile/blob/master/website/v2.yaml), [v3config](https://github.com/gurusabarish/hugo-profile/blob/master/website/v3.yaml) as base template.
- 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
@@ -59,22 +40,22 @@ 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/master/website/v1.yaml), [v2config](https://github.com/gurusabarish/hugo-profile/blob/master/website/v2.yaml), [v3config](https://github.com/gurusabarish/hugo-profile/blob/master/website/v3.yaml) as base template.
- 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 website folder. Netlify will automatically deploy your changes every time you modify the repo.
- 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 website folder. Github action will automatically deploy your changes to demo branch every time you modify the repo.
- 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 veiw the local change with `hugo --gc --minify --themesDir . serve` from within the website dir.
- If you clone the repo locally, you can view the local change with `hugo --gc --minify --themesDir . serve` from within the exampleSite dir.
## Deployment

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

Before

Width:  |  Height:  |  Size: 7.8 KiB

After

Width:  |  Height:  |  Size: 7.8 KiB

Before

Width:  |  Height:  |  Size: 5.1 KiB

After

Width:  |  Height:  |  Size: 5.1 KiB

Before

Width:  |  Height:  |  Size: 2.2 KiB

After

Width:  |  Height:  |  Size: 2.2 KiB

Before

Width:  |  Height:  |  Size: 248 KiB

After

Width:  |  Height:  |  Size: 248 KiB

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 147 KiB

BIN
View File
Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 191 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 497 KiB

+9 -9
View File
@@ -1,33 +1,33 @@
[build]
publish = "website/public"
command = "cd website && hugo --gc --minify --themesDir ../.."
publish = "exampleSite/public"
command = "cd exampleSite && hugo --gc --minify --themesDir ../.."
[context.production.environment]
HUGO_VERSION = "0.76.5"
HUGO_VERSION = "0.92.0"
HUGO_ENV = "production"
HUGO_ENABLEGITINFO = "true"
HUGO_THEME = "repo"
[context.split1]
command = "cd website && hugo --gc --minify --enableGitInfo --themesDir ../.."
command = "cd exampleSite && hugo --gc --minify --enableGitInfo --themesDir ../.."
[context.split1.environment]
HUGO_VERSION = "0.76.5"
HUGO_VERSION = "0.92.0"
HUGO_ENV = "production"
HUGO_THEME = "repo"
[context.deploy-preview]
command = "cd website && hugo --gc --minify --buildFuture --themesDir ../.. -b $DEPLOY_PRIME_URL"
command = "cd exampleSite && hugo --gc --minify --buildFuture --themesDir ../.. -b $DEPLOY_PRIME_URL"
[context.deploy-preview.environment]
HUGO_VERSION = "0.76.5"
HUGO_VERSION = "0.92.0"
HUGO_THEME = "repo"
[context.branch-deploy]
command = "cd website && hugo --gc --minify --themesDir ../.. -b $DEPLOY_PRIME_URL"
command = "cd exampleSite && hugo --gc --minify --themesDir ../.. -b $DEPLOY_PRIME_URL"
[context.branch-deploy.environment]
HUGO_VERSION = "0.76.5"
HUGO_VERSION = "0.92.0"
[context.next.environment]
HUGO_ENABLEGITINFO = "true"