Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
gurusabarish committed Mar 23, 2022
1 parent 7676361 commit 8e608c1
Show file tree
Hide file tree
Showing 29 changed files with 14 additions and 156 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/custom.md

This file was deleted.

20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

19 changes: 0 additions & 19 deletions .github/stale.yml

This file was deleted.

36 changes: 0 additions & 36 deletions .github/workflows/deploy.yml

This file was deleted.

29 changes: 5 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Binary file removed images/screenshot.png
Binary file not shown.
Binary file removed images/tn.png
Binary file not shown.
Binary file removed images/v1-demo.png
Binary file not shown.
Binary file removed images/v2-demo.png
Binary file not shown.
Binary file removed images/v3-demo.png
Binary file not shown.
18 changes: 9 additions & 9 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit 8e608c1

Please sign in to comment.